diff options
Diffstat (limited to '')
-rw-r--r-- | collectors/node.d.plugin/fronius/README.md (renamed from conf.d/node.d/fronius.conf.md) | 53 | ||||
-rw-r--r-- | collectors/node.d.plugin/named/README.md (renamed from conf.d/node.d/named.conf.md) | 2 | ||||
-rw-r--r-- | collectors/node.d.plugin/node.d.conf (renamed from conf.d/node.d.conf) | 0 | ||||
-rw-r--r-- | collectors/node.d.plugin/sma_webbox/README.md (renamed from conf.d/node.d/sma_webbox.conf.md) | 2 | ||||
-rw-r--r-- | collectors/node.d.plugin/snmp/README.md (renamed from conf.d/node.d/snmp.conf.md) | 12 | ||||
-rw-r--r-- | collectors/node.d.plugin/stiebeleltron/README.md (renamed from conf.d/node.d/stiebeleltron.conf.md) | 54 | ||||
-rw-r--r-- | conf.d/node.d/README.md | 7 |
7 files changed, 112 insertions, 18 deletions
diff --git a/conf.d/node.d/fronius.conf.md b/collectors/node.d.plugin/fronius/README.md index 622086b27..dd2846990 100644 --- a/conf.d/node.d/fronius.conf.md +++ b/collectors/node.d.plugin/fronius/README.md @@ -1,3 +1,56 @@ +# fronius + +This module collects metrics from the configured solar power installation from Fronius Symo. + +**Requirements** + * Configuration file `fronius.conf` in the node.d netdata config dir (default: `/etc/netdata/node.d/fronius.conf`) + * Fronius Symo with network access (http) + +It produces per server: + +1. **Power** + * Current power input from the grid (positive values), output to the grid (negative values), in W + * Current power input from the solar panels, in W + * Current power stored in the accumulator (if present), in W (in theory, untested) + +2. **Consumption** + * Local consumption in W + +3. **Autonomy** + * Relative autonomy in %. 100 % autonomy means that the solar panels are delivering more power than it is needed by local consumption. + * Relative self consumption in %. The lower the better + +4. **Energy** + * The energy produced during the current day, in kWh + * The energy produced during the current year, in kWh + +5. **Inverter** + * The current power output from the connected inverters, in W, one dimension per inverter. At least one is always present. + + +### configuration + +Sample: + +```json +{ + "enable_autodetect": false, + "update_every": 5, + "servers": [ + { + "name": "Symo", + "hostname": "symo.ip.or.dns", + "update_every": 5, + "api_path": "/solar_api/v1/GetPowerFlowRealtimeData.fcgi" + } + ] +} +``` + +If no configuration is given, the module will be disabled. Each `update_every` is optional, the default is `5`. + +--- + [Fronius Symo 8.2](https://www.fronius.com/en/photovoltaics/products/all-products/inverters/fronius-symo/fronius-symo-8-2-3-m) The plugin has been tested with a single inverter, namely Fronius Symo 8.2-3-M: diff --git a/conf.d/node.d/named.conf.md b/collectors/node.d.plugin/named/README.md index fa843dd58..977a5015f 100644 --- a/conf.d/node.d/named.conf.md +++ b/collectors/node.d.plugin/named/README.md @@ -2,8 +2,6 @@ Using this netdata collector, you can monitor one or more ISC Bind servers.
-The source code for this plugin in [here](https://github.com/firehol/netdata/blob/master/node.d/named.node.js).
-
## Example netdata charts
Depending on the number of views your bind has, you may get a large number of charts.
diff --git a/conf.d/node.d.conf b/collectors/node.d.plugin/node.d.conf index 95aec99ce..95aec99ce 100644 --- a/conf.d/node.d.conf +++ b/collectors/node.d.plugin/node.d.conf diff --git a/conf.d/node.d/sma_webbox.conf.md b/collectors/node.d.plugin/sma_webbox/README.md index 19fdc9dd3..1512c7008 100644 --- a/conf.d/node.d/sma_webbox.conf.md +++ b/collectors/node.d.plugin/sma_webbox/README.md @@ -1,5 +1,5 @@ -[SMA Sunny Webbox](http://www.solar-is-future.com/sma-technology-for-our-future/products/sunny-webbox/index.html)
+[SMA Sunny Webbox](http://files.sma.de/dl/4253/WEBBOX-DUS131916W.pdf)
Example netdata configuration for node.d/sma_webbox.conf
diff --git a/conf.d/node.d/snmp.conf.md b/collectors/node.d.plugin/snmp/README.md index 6b496f7a8..a307a3642 100644 --- a/conf.d/node.d/snmp.conf.md +++ b/collectors/node.d.plugin/snmp/README.md @@ -10,8 +10,6 @@ This collector supports: - each SNMP device may have a different update frequency - each SNMP device will accept one or more batches to report values (you can set `max_request_size` per SNMP server, to control the size of batches). -The source code of the plugin is [here](https://github.com/firehol/netdata/blob/master/node.d/snmp.node.js). - ## Configuration You will need to create the file `/etc/netdata/node.d/snmp.conf` with data like the following. @@ -23,7 +21,7 @@ In this example: - we will update the values every 10 seconds (`update_every: 10` under the server `10.11.12.8`). - we define 2 charts `snmp_switch.bandwidth_port1` and `snmp_switch.bandwidth_port2`, each having 2 dimensions: `in` and `out`. -```js +```json { "enable_autodetect": false, "update_every": 5, @@ -105,7 +103,7 @@ Each of the 24 new charts will have its id (1-24) appended at: 3. its `oid` (for all dimensions), i.e. dimension `in` will be `1.3.6.1.2.1.2.2.1.10.1` to `1.3.6.1.2.1.2.2.1.10.24` 3. its priority (which will be incremented for each chart so that the charts will appear on the dashboard in this order) -```js +```json { "enable_autodetect": false, "update_every": 10, @@ -154,7 +152,7 @@ The `options` given for each server, are: - `port`, the port of the SNMP device to connect to. The default is `161`. - `retries`, the number of attempts to make to fetch the data. The default is `1`. -## Retreiving names from snmp +## Retrieving names from snmp You can append a value retrieved from SNMP to the title, by adding `titleoid` to the chart. @@ -177,7 +175,7 @@ If it works, restart netdata to activate the snmp collector and refresh the dash ## Data collection speed -Keep in mind that many SNMP switches are routers are very slow. They may not be able to report values per second. If you run `node.d.plugin` in `debug` mode, it will report the time it took for the SNMP device to respond. My switch, for example, needs 7-8 seconds to respond for the traffic on 24 ports (48 OIDs, in/out). +Keep in mind that many SNMP switches and routers are very slow. They may not be able to report values per second. If you run `node.d.plugin` in `debug` mode, it will report the time it took for the SNMP device to respond. My switch, for example, needs 7-8 seconds to respond for the traffic on 24 ports (48 OIDs, in/out). Also, if you use many SNMP clients on the same SNMP device at the same time, values may be skipped. This is a problem of the SNMP device, not this collector. @@ -210,7 +208,7 @@ This switch also reports various other metrics, like snmp, packets per port, etc This switch has a very slow SNMP processors. To respond, it needs about 8 seconds, so I have set the refresh frequency (`update_every`) to 15 seconds. -```js +```json { "enable_autodetect": false, "update_every": 5, diff --git a/conf.d/node.d/stiebeleltron.conf.md b/collectors/node.d.plugin/stiebeleltron/README.md index 6ae5aa1c7..002a31571 100644 --- a/conf.d/node.d/stiebeleltron.conf.md +++ b/collectors/node.d.plugin/stiebeleltron/README.md @@ -1,3 +1,55 @@ +# stiebel eltron + +This module collects metrics from the configured heat pump and hot water installation from Stiebel Eltron ISG web. + +**Requirements** + * Configuration file `stiebeleltron.conf` in the node.d netdata config dir (default: `/etc/netdata/node.d/stiebeleltron.conf`) + * Stiebel Eltron ISG web with network access (http), without password login + +The charts are configurable, however, the provided default configuration collects the following: + +1. **General** + * Outside temperature in C + * Condenser temperature in C + * Heating circuit pressure in bar + * Flow rate in l/min + * Output of water and heat pumps in % + +2. **Heating** + * Heat circuit 1 temperature in C (set/actual) + * Heat circuit 2 temperature in C (set/actual) + * Flow temperature in C (set/actual) + * Buffer temperature in C (set/actual) + * Pre-flow temperature in C + +3. **Hot Water** + * Hot water temperature in C (set/actual) + +4. **Room Temperature** + * Heat circuit 1 room temperature in C (set/actual) + * Heat circuit 2 room temperature in C (set/actual) + +5. **Eletric Reheating** + * Dual Mode Reheating temperature in C (hot water/heating) + +6. **Process Data** + * Remaining compressor rest time in s + +7. **Runtime** + * Compressor runtime hours (hot water/heating) + * Reheating runtime hours (reheating 1/reheating 2) + +8. **Energy** + * Compressor today in kWh (hot water/heating) + * Compressor Total in kWh (hot water/heating) + + +### configuration + +If no configuration is given, the module will be disabled. Each `update_every` is optional, the default is `10`. + +--- + [Stiebel Eltron Heat pump system with ISG](https://www.stiebel-eltron.com/en/home/products-solutions/renewables/controller_energymanagement/internet_servicegateway/isg_web.html) Original author: BrainDoctor (github) @@ -24,7 +76,7 @@ In my case, the ISG is relatively slow with responding (at least 1s, but also up * The dimensions support variable digits, the default is `1`. Most of the values printed by ISG are using 1 digit, some use 2. * The dimensions also support the `multiplier` and `divisor` attributes, however the divisor gets overridden by `digits`, if specified. Default is `1`. * The test string for the regex is always the whole HTML output from the url. For each parameter you need to have a regular expression that extracts the value from the HTML source in the first capture group. - Recommended: [regexr.com](regexr.com) for testing and matching, [freeformatter.com](https://www.freeformatter.com/json-escape.html) for escaping the newly created regex for the JSON config. + Recommended: [regexr.com](https://regexr.com/) for testing and matching, [freeformatter.com](https://www.freeformatter.com/json-escape.html) for escaping the newly created regex for the JSON config. The charts are being generated using the configuration below. So if your installation is in another language or has other metrics, just adapt the structure or regexes. ### Configuration template diff --git a/conf.d/node.d/README.md b/conf.d/node.d/README.md deleted file mode 100644 index 45e3d02a6..000000000 --- a/conf.d/node.d/README.md +++ /dev/null @@ -1,7 +0,0 @@ -`node.d.plugin` modules accept configuration in JSON format. - -Unfortunately, JSON files do not accept comments. So, the best way to describe them is to have markdown text files with instructions. - -JSON has a very strict formatting. If you get errors from netdata at `/var/log/netdata/error.log` that a certain configuration file cannot be loaded, we suggest to verify it at [http://jsonlint.com/](http://jsonlint.com/). - -The files in this directory, provide usable examples for configuring each `node.d.plugin` module. |