From bc0bf0f3933d03c6c18de72c271f2fd8331aef19 Mon Sep 17 00:00:00 2001 From: thl-cmk <thl-cmk@outlook.com> Date: Sat, 2 Sep 2023 10:37:15 +0000 Subject: [PATCH] Update README.md --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index f1f0421..a3c3182 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,7 @@ [PACKAGE]: ../../raw/master/vzlogger-0.0.1-20230806.mkp "vzlogger-0.0.1-20230806.mkp" -# Title +# Monitors values form the vzlogger middleware -A short description about the plugin - -if there are more than on plugin put it in collapsable sections -<details><summary>check_plugin_1</summary> - -</details> -<details><summary>check_pluhin_2</summary> - -</details> +see https://wiki.volkszaehler.org/software/controller/vzlogger --- ### Download @@ -20,8 +12,8 @@ if there are more than on plugin put it in collapsable sections You can install the package by uploading it to your CheckMK site and as site user run ``` -mkp install PAKAGE_NAME.mkp -mkp enable PAKAGE_NAME VERSION +mkp install vzlogger-0.0.1-20230806.mkp +mkp enablevzlogger-0.0.1 20230806 ``` In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) @@ -34,15 +26,15 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut --- ### Check Info -The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT with the **_HOW_TO_BUILD_THE_ITEM_** as item +The plugin creates for each configured UUID a service. The item depends on the configured _channel type_ and _service name_ (see discovery rule). For not configured UUIDs it will create a service __vzlogger__ with the __UUID__ as item. + <details><summary>Montoring states</summary> | State | condition | WATO | -| ------ | ------ | ------ | -| WARN | condition 1 | yes | -| CRIT | condition 2 | no | -| WARN/CRIT | condition 3 | no | +| ----- | --------- | ---- | +| WARN/CRIT | if outside of configured levels (upper/lower) | yes | +| UNKNOWN | if channel type for UUID is not configured | yed (Discovery rule) | </details> @@ -50,9 +42,11 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | Metric | Unit | Perfometer | | ------ | ------ | ------ | -| METRIC 1 | bit/s | yes | -| METRIC 2 | C | yes | -| METRIC 3 | V | no | +| Electrical power | W | yes | +| Meter reading | Wh | yes | +| Electrical voltage | V | yes | + +__Note:__ the actual perfdata depends on the configured channel type (see Discovery rule) </details> @@ -62,14 +56,14 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | Section | Rule name | | ------ | ------ | -| Networking | NAME_OF_THE_RULE | +| Applications, Processes & Services | vzlogger | | Option | Defailt value | | ------ | ------ | -| OPTION 1 | 10/50| -| OPTION 2 | 70/90 | -| OPTION 3 | CHOICE 1 | -| OPTION 4 | disabled | +| Levels (upper) | none| +| Levels lower | none | + +__Note:__ _Levels (upper)_ can use predictive levels. In this case the _Levels lower_ will be ignored. </details> @@ -77,16 +71,20 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi | Section | Rule name | | ------ | ------ | -| Discovery of individual services | NAME_OF_THE_RULE | +| Discovery of individual services | vzlogger | | Option | Defailt value | | ------ | ------ | -| OPTION 1 | disabled | +| Channels | empty | -</details> +options for each Channels + +| Option | Value | Description | +| ------ | ----- | ----------- | +| UUID | uuid form vzlogger output | unique identifiter of the vzlogger channel | +| Channel type | Electrical Power(W)/Meter reading/Voltage (V) | This will define the service name | +| Service name (item) | Item | short name of the channel, this will become the item | -<details><summary>HW/SW inventory rules</summary> -The inventory plugin is not configurable. </details> --- -- GitLab