Commit 19aae95b authored by Andreas Unterkircher's avatar Andreas Unterkircher

README.md, add release information, prettify code-blocks

parent 45e4f990
......@@ -8,6 +8,12 @@ The plugin queries the modem-state and channel status (ie. power, signal-noise-r
Additionally it outputs the read values as performance data.
## Releases
See the [CHANGELOG.md](./CHANGELOG.md) for release information.
The latest version of this plugin can be found on the site [netshadow.org](https://netshadow.org).
## Requirements
* monitoring-common-shell-library
......@@ -33,15 +39,69 @@ Additionally it outputs the read values as performance data.
```shell
./check_technicolor_docsis.sh --ignore up2,ds2 -w '/^downstream_.+_power/=10:-10,/^downstream_.+snr/=35:,/^upstream_.+_power/=40:,modem_state=scanning' -c '/^downstream_.+_power/=15:-15,/^downstream_.+snr/=30:,/^upstream_.+_power/=35:,modem_state=unknown'
./check_technicolor_docsis.sh ↩
--ignore up2,ds2 ↩
-w '/^downstream_.+_power/=10:-10, ↩
/^downstream_.+snr/=35:, ↩
/^upstream_.+_power/=40:, ↩
modem_state=scanning' ↩
-c '/^downstream_.+_power/=15:-15, ↩
/^downstream_.+snr/=30:, ↩
/^upstream_.+_power/=35:, ↩
modem_state=unknown'
```
## Example Output
Note that the below output is prettified here - actually the plugin output is a one-liner.
```shell
user@host:~$ ./check_technicolor_docsis.sh upstream_channel1_power:41.0dBmV(CRITICAL), downstream_channel2_power:-0.7dBmV(OK), upstream_channel4_power:0.0dBmV(CRITICAL), downstream_channel3_snr:38.7dB(OK), upstream_channel2_power:41.2dBmV(CRITICAL), upstream_channel3_power:0.0dBmV(CRITICAL), downstream_channel2_snr:38.8dB(OK), downstream_channel8_power:-2.4dBmV(OK), downstream_channel6_snr:38.4dB(OK), downstream_channel6_power:-1.8dBmV(OK), downstream_channel5_power:-1.3dBmV(OK), downstream_channel8_snr:38.2dB(OK), modem_state:operational(OK), downstream_channel4_power:-2.2dBmV(OK), downstream_channel3_power:-1.3dBmV(OK), downstream_channel7_snr:38.2dB(OK), downstream_channel1_power:-0.1dBmV(OK), downstream_channel7_power:-1.7dBmV(OK), downstream_channel4_snr:38.2dB(OK), downstream_channel1_snr:38.6dB(OK), downstream_channel5_snr:38.6dB(OK)|upstream_channel1_power=41.0;50:;55: downstream_channel2_power=-0.7;10:-10;15:-15 upstream_channel4_power=0.0;50:;55: downstream_channel3_snr=38.7;35:;30: upstream_channel2_power=41.2;50:;55: upstream_channel3_power=0.0;50:;55: downstream_channel2_snr=38.8;35:;30: downstream_channel8_power=-2.4;10:-10;15:-15 downstream_channel6_snr=38.4;35:;30: downstream_channel6_power=-1.8;10:-10;15:-15 downstream_channel5_power=-1.3;10:-10;15:-15 downstream_channel8_snr=38.2;35:;30: downstream_channel4_power=-2.2;10:-10;15:-15 downstream_channel3_power=-1.3;10:-10;15:-15 downstream_channel7_snr=38.2;35:;30: downstream_channel1_power=-0.1;10:-10;15:-15 downstream_channel7_power=-1.7;10:-10;15:-15 downstream_channel4_snr=38.2;35:;30: downstream_channel1_snr=38.6;35:;30: downstream_channel5_snr=38.6;35:;30: plugin_time=2368ms
user@host:~$ ./check_technicolor_docsis.sh ↩
upstream_channel1_power:41.0dBmV(CRITICAL), ↩
downstream_channel2_power:-0.7dBmV(OK), ↩
upstream_channel4_power:0.0dBmV(CRITICAL), ↩
downstream_channel3_snr:38.7dB(OK), ↩
upstream_channel2_power:41.2dBmV(CRITICAL), ↩
upstream_channel3_power:0.0dBmV(CRITICAL), ↩
downstream_channel2_snr:38.8dB(OK), ↩
downstream_channel8_power:-2.4dBmV(OK), ↩
downstream_channel6_snr:38.4dB(OK), ↩
downstream_channel6_power:-1.8dBmV(OK), ↩
downstream_channel5_power:-1.3dBmV(OK), ↩
downstream_channel8_snr:38.2dB(OK), ↩
modem_state:operational(OK), ↩
downstream_channel4_power:-2.2dBmV(OK), ↩
downstream_channel3_power:-1.3dBmV(OK), ↩
downstream_channel7_snr:38.2dB(OK), ↩
downstream_channel1_power:-0.1dBmV(OK), ↩
downstream_channel7_power:-1.7dBmV(OK), ↩
downstream_channel4_snr:38.2dB(OK), ↩
downstream_channel1_snr:38.6dB(OK), ↩
downstream_channel5_snr:38.6dB(OK) ↩
# note: here the performance counter section starts
|upstream_channel1_power=41.0;50:;55: ↩
downstream_channel2_power=-0.7;10:-10;15:-15 ↩
upstream_channel4_power=0.0;50:;55: ↩
downstream_channel3_snr=38.7;35:;30: ↩
upstream_channel2_power=41.2;50:;55: ↩
upstream_channel3_power=0.0;50:;55: ↩
downstream_channel2_snr=38.8;35:;30: ↩
downstream_channel8_power=-2.4;10:-10;15:-15 ↩
downstream_channel6_snr=38.4;35:;30: ↩
downstream_channel6_power=-1.8;10:-10;15:-15 ↩
downstream_channel5_power=-1.3;10:-10;15:-15 ↩
downstream_channel8_snr=38.2;35:;30: ↩
downstream_channel4_power=-2.2;10:-10;15:-15 ↩
downstream_channel3_power=-1.3;10:-10;15:-15 ↩
downstream_channel7_snr=38.2;35:;30: ↩
downstream_channel1_power=-0.1;10:-10;15:-15 ↩
downstream_channel7_power=-1.7;10:-10;15:-15 ↩
downstream_channel4_snr=38.2;35:;30: ↩
downstream_channel1_snr=38.6;35:;30: ↩
downstream_channel5_snr=38.6;35:;30: ↩
plugin_time=2368ms
```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment