Sophia/librenms-speedtest
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Modernized the plugin

Browse Source 
Implemented fixes from Gitlab issues
from Marc Hagen & Trent Robinson (https://gitlab.com/jackgreyhat/librenms-speedtest/-/issues/2)
and fixes from m0nsieur Psych0 (https://gitlab.com/jackgreyhat/librenms-speedtest/-/issues/6)

I added support for darkmode, this is done by generating the graphs with white text, then using CSS to invert the image, for light mode users.

I also moved branding PNGs to vectors for higher resolutions

I will not be opening a PR at https://gitlab.com/jackgreyhat/librenms-speedtest as this seems to have been abbandoned.
This commit is contained in:
Sophia Atkinson
2023-09-15 15:59:51 -07:00
parent a0747a0fab
commit 8a516b8664
7 changed files with 295 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

274
librenms-speedtest.sh
View File

@ -34,7 +34,7 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
DATE=$(/bin/date +%s)
# Generate speedtest results, store them in a temp file
speedtest --accept-license --accept-gdpr -p no > $SpeedtestResultDir/speedtest-results 2>/dev/null
speedtest -p no > $SpeedtestResultDir/speedtest-results 2>/dev/null
# Get the Latency
Latency=$(cat $SpeedtestResultDir/speedtest-results | grep Latency | sed 's/.*Latency:\s*\([0-9]*.[0-9]*\).*/\1/')
@ -55,7 +55,6 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
(graph)
# Create the Latency PNG of the last day
rrdtool graph $PNGImagesDir/speedtest-latency-day.png -J -a PNG --start "-1day" \
--title="Last Day" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
@ -74,13 +73,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last week
rrdtool graph $PNGImagesDir/speedtest-latency-week.png -J -a PNG --start "-1week" \
--title="Last Week" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
@ -99,13 +97,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last month
rrdtool graph $PNGImagesDir/speedtest-latency-month.png -J -a PNG --start "-1month" \
--title="Last Month" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
@ -124,13 +121,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last year
rrdtool graph $PNGImagesDir/speedtest-latency-year.png -J -a PNG --start "-1year" \
--title="Last Year" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
@ -149,13 +145,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last day
rrdtool graph $PNGImagesDir/speedtest-bandwidth-day.png -J -a PNG --start "-1day" \
--title="Last Day" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
@ -188,13 +183,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last week
rrdtool graph $PNGImagesDir/speedtest-bandwidth-week.png -J -a PNG --start "-1week" \
--title="Last Week" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
@ -227,13 +221,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last month
rrdtool graph $PNGImagesDir/speedtest-bandwidth-month.png -J -a PNG --start "-1month" \
--title="Last Month" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
@ -266,13 +259,12 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last year
rrdtool graph $PNGImagesDir/speedtest-bandwidth-year.png -J -a PNG --start "-1year" \
--title="Last Year" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
@ -305,7 +297,255 @@ SpeedtestResultDir=$SpeedtestPluginDir/tmp
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000000 \
-c FONT#bdbfbfff \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last day
rrdtool graph $PNGImagesDir/speedtest-latency-light-day.png -J -a PNG --start "-1day" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
DEF:PMAX=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MAX \
VDEF:Pavg=P,AVERAGE \
LINE1:Pavg#cc3300:"Avg \n" \
LINE2:P#3d61ab:"Last latency (ms)\n" \
GPRINT:Pavg:"Avg latency %2.1lf ms\n" \
-h 500 -w 1000 -y1:2 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last week
rrdtool graph $PNGImagesDir/speedtest-latency-light-week.png -J -a PNG --start "-1week" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
DEF:PMAX=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MAX \
VDEF:Pavg=P,AVERAGE \
LINE1:Pavg#cc3300:"Avg \n" \
LINE2:P#3d61ab:"Last latency (ms)\n" \
GPRINT:Pavg:"Avg latency %2.1lf ms\n" \
-h 500 -w 1000 -y1:2 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last month
rrdtool graph $PNGImagesDir/speedtest-latency-light-month.png -J -a PNG --start "-1month" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
DEF:PMAX=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MAX \
VDEF:Pavg=P,AVERAGE \
LINE1:Pavg#cc3300:"Avg \n" \
LINE2:P#3d61ab:"Last latency (ms)\n" \
GPRINT:Pavg:"Avg latency %2.1lf ms\n" \
-h 500 -w 1000 -y1:2 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Latency PNG of the last year
rrdtool graph $PNGImagesDir/speedtest-latency-light-year.png -J -a PNG --start "-1year" \
--vertical-label "ms" \
DEF:P=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:AVERAGE \
DEF:PMIN=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MIN \
DEF:PMAX=$RRDGraphsDir/speedtest-latency.rrd:LATENCY:MAX \
VDEF:Pavg=P,AVERAGE \
LINE1:Pavg#cc3300:"Avg \n" \
LINE2:P#3d61ab:"Last latency (ms)\n" \
GPRINT:Pavg:"Avg latency %2.1lf ms\n" \
-h 500 -w 1000 -y1:2 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last day
rrdtool graph $PNGImagesDir/speedtest-bandwidth-light-day.png -J -a PNG --start "-1day" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
DEF:DMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MAX \
DEF:U=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:AVERAGE \
DEF:UMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MIN \
DEF:UMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MAX \
CDEF:Y0=U,0,* \
CDEF:NegU=U,-1,* \
VDEF:Yavg=Y0,AVERAGE \
VDEF:Davg=D,AVERAGE \
VDEF:Uavg=NegU,AVERAGE \
VDEF:Uavg2=U,AVERAGE \
AREA:D#61ab3d:"Download" \
AREA:NegU#3d61ab:"Upload" \
LINE1:Uavg#cc1100: \
LINE1:Davg#cc3300:"Avg\n" \
LINE1:Yavg#111111: \
GPRINT:D:LAST:"Last download bandwidth\: %2.1lf Mb/s\n" \
GPRINT:U:LAST:"Last upload bandwidth\: %2.1lf Mb/s\n" \
GPRINT:Davg:"Avg download bandwidth %2.1lf Mb/s\n" \
GPRINT:Uavg2:"Avg upload bandwidth %2.1lf Mb/s" \
-h 500 -w 1000 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last week
rrdtool graph $PNGImagesDir/speedtest-bandwidth-light-week.png -J -a PNG --start "-1week" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
DEF:DMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MAX \
DEF:U=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:AVERAGE \
DEF:UMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MIN \
DEF:UMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MAX \
CDEF:Y0=U,0,* \
CDEF:NegU=U,-1,* \
VDEF:Yavg=Y0,AVERAGE \
VDEF:Davg=D,AVERAGE \
VDEF:Uavg=NegU,AVERAGE \
VDEF:Uavg2=U,AVERAGE \
AREA:D#61ab3d:"Download" \
AREA:NegU#3d61ab:"Upload" \
LINE1:Uavg#cc1100: \
LINE1:Davg#cc3300:"Avg\n" \
LINE1:Yavg#111111: \
GPRINT:D:LAST:"Last download bandwidth\: %2.1lf Mb/s\n" \
GPRINT:U:LAST:"Last upload bandwidth\: %2.1lf Mb/s\n" \
GPRINT:Davg:"Avg download bandwidth %2.1lf Mb/s\n" \
GPRINT:Uavg2:"Avg upload bandwidth %2.1lf Mb/s" \
-h 500 -w 1000 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last month
rrdtool graph $PNGImagesDir/speedtest-bandwidth-light-month.png -J -a PNG --start "-1month" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
DEF:DMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MAX \
DEF:U=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:AVERAGE \
DEF:UMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MIN \
DEF:UMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MAX \
CDEF:Y0=U,0,* \
CDEF:NegU=U,-1,* \
VDEF:Yavg=Y0,AVERAGE \
VDEF:Davg=D,AVERAGE \
VDEF:Uavg=NegU,AVERAGE \
VDEF:Uavg2=U,AVERAGE \
AREA:D#61ab3d:"Download" \
AREA:NegU#3d61ab:"Upload" \
LINE1:Uavg#cc1100: \
LINE1:Davg#cc3300:"Avg\n" \
LINE1:Yavg#111111: \
GPRINT:D:LAST:"Last download bandwidth\: %2.1lf Mb/s\n" \
GPRINT:U:LAST:"Last upload bandwidth\: %2.1lf Mb/s\n" \
GPRINT:Davg:"Avg download bandwidth %2.1lf Mb/s\n" \
GPRINT:Uavg2:"Avg upload bandwidth %2.1lf Mb/s" \
-h 500 -w 1000 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
# Create the Bandwidth PNG of the last year
rrdtool graph $PNGImagesDir/speedtest-bandwidth-light-year.png -J -a PNG --start "-1year" \
--vertical-label "Mbit/s" \
DEF:D=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:AVERAGE \
DEF:DMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MIN \
DEF:DMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:DOWN:MAX \
DEF:U=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:AVERAGE \
DEF:UMIN=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MIN \
DEF:UMAX=$RRDGraphsDir/speedtest-bandwidth.rrd:UP:MAX \
CDEF:Y0=U,0,* \
CDEF:NegU=U,-1,* \
VDEF:Yavg=Y0,AVERAGE \
VDEF:Davg=D,AVERAGE \
VDEF:Uavg=NegU,AVERAGE \
VDEF:Uavg2=U,AVERAGE \
AREA:D#61ab3d:"Download" \
AREA:NegU#3d61ab:"Upload" \
LINE1:Uavg#cc1100: \
LINE1:Davg#cc3300:"Avg\n" \
LINE1:Yavg#111111: \
GPRINT:D:LAST:"Last download bandwidth\: %2.1lf Mb/s\n" \
GPRINT:U:LAST:"Last upload bandwidth\: %2.1lf Mb/s\n" \
GPRINT:Davg:"Avg download bandwidth %2.1lf Mb/s\n" \
GPRINT:Uavg2:"Avg upload bandwidth %2.1lf Mb/s" \
-h 500 -w 1000 \
-c BACK#EEEEEE00 \
-c SHADEA#EEEEEE00 \
-c SHADEB#EEEEEE00 \
-c CANVAS#FFFFFF00 \
-c GRID#a5a5a5 \
-c MGRID#FF9999 \
-c FRAME#5e5e5e \
-c ARROW#5e5e5e \
-R normal \
-c FONT#000 \
--font LEGEND:8:DejaVuSansMono \
--font AXIS:7:DejaVuSansMono > /dev/null 2>&1
;;