diff options
| author | Promise Akpan <akpanpromise@hotmail.com> | 2019-08-15 12:06:39 +0100 |
|---|---|---|
| committer | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2019-08-15 13:06:39 +0200 |
| commit | f5006d51e8caf9148d393eb68d53dc9fcd28b7b6 (patch) | |
| tree | 03b757236d6b45e46813a4a875c77dc775e5f896 /collectors/node.d.plugin | |
| parent | 69172fd57472df75d877f43de2dcc693c48ab5c0 (diff) | |
Fix Markdown Lint warnings (#6664)
* make remark access all directories
* detailed fix after autofix by remark lint
* cross check autofix for this set of files
* crosscheck more files
* crosschecking and small fixes
* crosscheck autofixed md files
Diffstat (limited to 'collectors/node.d.plugin')
| -rw-r--r-- | collectors/node.d.plugin/README.md | 56 | ||||
| -rw-r--r-- | collectors/node.d.plugin/fronius/README.md | 53 | ||||
| -rw-r--r-- | collectors/node.d.plugin/named/README.md | 686 | ||||
| -rw-r--r-- | collectors/node.d.plugin/sma_webbox/README.md | 57 | ||||
| -rw-r--r-- | collectors/node.d.plugin/snmp/README.md | 59 | ||||
| -rw-r--r-- | collectors/node.d.plugin/stiebeleltron/README.md | 102 |
6 files changed, 512 insertions, 501 deletions
diff --git a/collectors/node.d.plugin/README.md b/collectors/node.d.plugin/README.md index fb7dce6bd2..6d7c1f8718 100644 --- a/collectors/node.d.plugin/README.md +++ b/collectors/node.d.plugin/README.md @@ -2,12 +2,12 @@ `node.d.plugin` is a Netdata external plugin. It is an **orchestrator** for data collection modules written in `node.js`. -1. It runs as an independent process `ps fax` shows it -2. It is started and stopped automatically by Netdata -3. It communicates with Netdata via a unidirectional pipe (sending data to the `netdata` daemon) -4. Supports any number of data collection **modules** -5. Allows each **module** to have one or more data collection **jobs** -6. Each **job** is collecting one or more metrics from a single data source +1. It runs as an independent process `ps fax` shows it +2. It is started and stopped automatically by Netdata +3. It communicates with Netdata via a unidirectional pipe (sending data to the `netdata` daemon) +4. Supports any number of data collection **modules** +5. Allows each **module** to have one or more data collection **jobs** +6. Each **job** is collecting one or more metrics from a single data source ## Pull Request Checklist for Node.js Plugins @@ -15,13 +15,13 @@ This is a generic checklist for submitting a new Node.js plugin for Netdata. It At minimum, to be buildable and testable, the PR needs to include: -* The module itself, following proper naming conventions: `node.d/<module_dir>/<module_name>.node.js` -* A README.md file for the plugin. -* The configuration file for the module -* A basic configuration for the plugin in the appropriate global config file: `conf.d/node.d.conf`, which is also in JSON format. If the module should be enabled by default, add a section for it in the `modules` dictionary. -* A line for the plugin in the appropriate `Makefile.am` file: `node.d/Makefile.am` under `dist_node_DATA`. -* A line for the plugin configuration file in `conf.d/Makefile.am`: under `dist_nodeconfig_DATA` -* Optionally, chart information in `web/dashboard_info.js`. This generally involves specifying a name and icon for the section, and may include descriptions for the section or individual charts. +- The module itself, following proper naming conventions: `node.d/<module_dir>/<module_name>.node.js` +- A README.md file for the plugin. +- The configuration file for the module +- A basic configuration for the plugin in the appropriate global config file: `conf.d/node.d.conf`, which is also in JSON format. If the module should be enabled by default, add a section for it in the `modules` dictionary. +- A line for the plugin in the appropriate `Makefile.am` file: `node.d/Makefile.am` under `dist_node_DATA`. +- A line for the plugin configuration file in `conf.d/Makefile.am`: under `dist_nodeconfig_DATA` +- Optionally, chart information in `web/dashboard_info.js`. This generally involves specifying a name and icon for the section, and may include descriptions for the section or individual charts. ## Motivation @@ -40,7 +40,7 @@ To run `node.js` plugins you need to have `node` installed in your system. In some older systems, the package named `node` is not node.js. It is a terminal emulation program called `ax25-node`. In this case the node.js package may be referred as `nodejs`. Once you install `nodejs`, we suggest to link `/usr/bin/nodejs` to `/usr/bin/node`, so that typing `node` in your terminal, opens node.js. -For more information check the **[[Installation]]** guide. +For more information check the **\[[Installation]]** guide. ## configuring `node.d.plugin` @@ -55,11 +55,10 @@ Unfortunately, `JSON` files do not accept comments. So, the best way to describe 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/). +configuration file cannot be loaded, we suggest to verify it at <http://jsonlint.com/>. The files in this directory, provide usable examples for configuring each `node.d.plugin` module. - ## debugging modules written for node.d.plugin To test `node.d.plugin` modules, which are placed in `/usr/libexec/netdata/node.d`, you can run `node.d.plugin` by hand, @@ -89,15 +88,15 @@ export NETDATA_USER_CONFIG_DIR="/path/to/etc/netdata" Your data collection module should be split in 3 parts: - - a function to fetch the data from its source. `node.d.plugin` already can fetch data from web sources, - so you don't need to do anything about it for http. +- a function to fetch the data from its source. `node.d.plugin` already can fetch data from web sources, + so you don't need to do anything about it for http. - - a function to process the fetched/manipulate the data fetched. This function will make a number of calls - to create charts and dimensions and pass the collected values to Netdata. - This is the only function you need to write for collecting http JSON data. +- a function to process the fetched/manipulate the data fetched. This function will make a number of calls + to create charts and dimensions and pass the collected values to Netdata. + This is the only function you need to write for collecting http JSON data. - - a `configure` and an `update` function, which take care of your module configuration and data refresh - respectively. You can use the supplied ones. +- a `configure` and an `update` function, which take care of your module configuration and data refresh + respectively. You can use the supplied ones. Your module will automatically be able to process any number of servers, with different settings (even different data collection frequencies). You will write just the work needed for one and `node.d.plugin` will do the rest. @@ -108,7 +107,6 @@ For each server you are going to fetch data from, you will have to create a `ser To provide a module called `mymodule`, you have create the file `/usr/libexec/netdata/node.d/mymodule.node.js`, with this structure: ```js - // the processor is needed only // if you need a custom processor // other than http @@ -223,12 +221,12 @@ The configuration file `/etc/netdata/node.d/mymodule.conf` may contain whatever The `service` object defines a set of functions to allow you send information to the Netdata core about: -1. Charts and dimension definitions -2. Updated values, from the collected values +1. Charts and dimension definitions +2. Updated values, from the collected values --- -*FIXME: document an operational node.d.plugin data collector - the best example is the -[snmp collector](snmp/snmp.node.js)* +_FIXME: document an operational node.d.plugin data collector - the best example is the +[snmp collector](snmp/snmp.node.js)_ -[]() +[](<>) diff --git a/collectors/node.d.plugin/fronius/README.md b/collectors/node.d.plugin/fronius/README.md index c70e7f72ee..f109f79950 100644 --- a/collectors/node.d.plugin/fronius/README.md +++ b/collectors/node.d.plugin/fronius/README.md @@ -3,32 +3,37 @@ 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) + +- 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) +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** -2. **Consumption** - * Local consumption in W +- 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 -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** -4. **Energy** - * The energy produced during the current day, in kWh - * The energy produced during the current year, in kWh +- 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 +5. **Inverter** + +- The current power output from the connected inverters, in W, one dimension per inverter. At least one is always present. + +## configuration Sample: @@ -55,14 +60,15 @@ If no configuration is given, the module will be disabled. Each `update_every` i The plugin has been tested with a single inverter, namely Fronius Symo 8.2-3-M: -- Datalogger version: 240.162630 -- Software version: 3.7.4-6 -- Hardware version: 2.4D +- Datalogger version: 240.162630 +- Software version: 3.7.4-6 +- Hardware version: 2.4D Other products and versions may work, but without any guarantees. Example Netdata configuration for node.d/fronius.conf. Copy this section to fronius.conf and change name/ip. The module supports any number of servers. Sometimes there is a lag when collecting every 3 seconds, so 5 should be okay too. You can modify this per server. + ```json { "enable_autodetect": false, @@ -79,6 +85,7 @@ The module supports any number of servers. Sometimes there is a lag when collect ``` The output of /solar_api/v1/GetPowerFlowRealtimeData.fcgi looks like this: + ```json { "Head" : { @@ -119,4 +126,4 @@ The output of /solar_api/v1/GetPowerFlowRealtimeData.fcgi looks like this: } ``` -[]() +[](<>) diff --git a/collectors/node.d.plugin/named/README.md b/collectors/node.d.plugin/named/README.md index b3f7eaaf21..288292ba83 100644 --- a/collectors/node.d.plugin/named/README.md +++ b/collectors/node.d.plugin/named/README.md @@ -1,344 +1,342 @@ -# ISC Bind Statistics
-
-Using this Netdata collector, you can monitor one or more ISC Bind servers.
-
-## Example Netdata charts
-
-Depending on the number of views your bind has, you may get a large number of charts.
-Here this is with just one view:
-
-
-
-
-## How it works
-
-The plugin will execute (from within node.js) the equivalent of:
-
-```sh
-curl "http://localhost:8888/json/v1/server"
-```
-
-Here is a sample of the output this command produces.
-
-```js
-{
- "json-stats-version":"1.0",
- "boot-time":"2016-01-31T08:20:48Z",
- "config-time":"2016-01-31T09:28:03Z",
- "current-time":"2016-02-02T22:22:20Z",
- "opcodes":{
- "QUERY":247816,
- "IQUERY":0,
- "STATUS":0,
- "RESERVED3":0,
- "NOTIFY":0,
- "UPDATE":3813,
- "RESERVED6":0,
- "RESERVED7":0,
- "RESERVED8":0,
- "RESERVED9":0,
- "RESERVED10":0,
- "RESERVED11":0,
- "RESERVED12":0,
- "RESERVED13":0,
- "RESERVED14":0,
- "RESERVED15":0
- },
- "qtypes":{
- "A":89519,
- "NS":863,
- "CNAME":1,
- "SOA":1,
- "PTR":116779,
- "MX":276,
- "TXT":198,
- "AAAA":39324,
- "SRV":850,
- "ANY":5
- },
- "nsstats":{
- "Requestv4":251630,
- "ReqEdns0":1255,
- "ReqTSIG":3813,
- "ReqTCP":57,
- "AuthQryRej":1455,
- "RecQryRej":122,
- "Response":245918,
- "TruncatedResp":44,
- "RespEDNS0":1255,
- "RespTSIG":3813,
- "QrySuccess":205159,
- "QryAuthAns":119495,
- "QryNoauthAns":120770,
- "QryNxrrset":32711,
- "QrySERVFAIL":262,
- "QryNXDOMAIN":2395,
- "QryRecursion":40885,
- "QryDuplicate":5712,
- "QryFailure":1577,
- "UpdateDone":2514,
- "UpdateFail":1299,
- "UpdateBadPrereq":1276,
- "QryUDP":246194,
- "QryTCP":45,
- "OtherOpt":101
- },
- "views":{
- "local":{
- "resolver":{
- "stats":{
- "Queryv4":74577,
- "Responsev4":67032,
- "NXDOMAIN":601,
- "SERVFAIL":5,
- "FORMERR":7,
- "EDNS0Fail":7,
- "Truncated":3071,
- "Lame":4,
- "Retry":11826,
- "QueryTimeout":1838,
- "GlueFetchv4":6864,
- "GlueFetchv4Fail":30,
- "QryRTT10":112,
- "QryRTT100":42900,
- "QryRTT500":23275,
- "QryRTT800":534,
- "QryRTT1600":97,
- "QryRTT1600+":20,
- "BucketSize":31,
- "REFUSED":13
- },
- "qtypes":{
- "A":64931,
- "NS":870,
- "CNAME":185,
- "PTR":5,
- "MX":49,
- "TXT":149,
- "AAAA":7972,
- "SRV":416
- },
- "cache":{
- "A":40356,
- "NS":8032,
- "CNAME":14477,
- "PTR":2,
- "MX":21,
- "TXT":32,
- "AAAA":3301,
- "SRV":94,
- "DS":237,
- "RRSIG":2301,
- "NSEC":126,
- "!A":52,
- "!NS":4,
- "!TXT":1,
- "!AAAA":3797,
- "!SRV":9,
- "NXDOMAIN":590
- },
- "cachestats":{
- "CacheHits":1085188,
- "CacheMisses":109,
- "QueryHits":464755,
- "QueryMisses":55624,
- "DeleteLRU":0,
- "DeleteTTL":42615,
- "CacheNodes":5188,
- "CacheBuckets":2079,
- "TreeMemTotal":2326026,
- "TreeMemInUse":1508075,
- "HeapMemMax":132096,
- "HeapMemTotal":393216,
- "HeapMemInUse":132096
- },
- "adb":{
- "nentries":1021,
- "entriescnt":3157,
- "nnames":1021,
- "namescnt":3022
- }
- }
- },
- "public":{
- "resolver":{
- "stats":{
- "BucketSize":31
- },
- "qtypes":{
- },
- "cache":{
- },
- "cachestats":{
- "CacheHits":0,
- "CacheMisses":0,
- "QueryHits":0,
- "QueryMisses":0,
- "DeleteLRU":0,
- "DeleteTTL":0,
- "CacheNodes":0,
- "CacheBuckets":64,
- "TreeMemTotal":287392,
- "TreeMemInUse":29608,
- "HeapMemMax":1024,
- "HeapMemTotal":262144,
- "HeapMemInUse":1024
- },
- "adb":{
- "nentries":1021,
- "nnames":1021
- }
- }
- },
- "_bind":{
- "resolver":{
- "stats":{
- "BucketSize":31
- },
- "qtypes":{
- },
- "cache":{
- },
- "cachestats":{
- "CacheHits":0,
- "CacheMisses":0,
- "QueryHits":0,
- "QueryMisses":0,
- "DeleteLRU":0,
- "DeleteTTL":0,
- "CacheNodes":0,
- "CacheBuckets":64,
- "TreeMemTotal":287392,
- "TreeMemInUse":29608,
- "HeapMemMax":1024,
- "HeapMemTotal":262144,
- "HeapMemInUse":1024
- },
- "adb":{
- "nentries":1021,
- "nnames":1021
- }
- }
- }
- }
-}
-```
-
-
-From this output it collects:
-
-- Global Received Requests by IP version (IPv4, IPv6)
-- Global Successful Queries
-- Current Recursive Clients
-- Global Queries by IP Protocol (TCP, UDP)
-- Global Queries Analysis
-- Global Received Updates
-- Global Query Failures
-- Global Query Failures Analysis
-- Other Global Server Statistics
-- Global Incoming Requests by OpCode
-- Global Incoming Requests by Query Type
-- Global Socket Statistics (will only work if the url is `http://127.0.0.1:8888/json/v1`, i.e. without `/server`, but keep in mind this produces a very long output and probably will account for 0.5% CPU overhead alone, per bind server added)
-- Per View Statistics (the following set will be added for each bind view):
- - View, Resolver Active Queries
- - View, Resolver Statistics
- - View, Resolver Round Trip Timings
- - View, Requests by Query Type
-
-## Configuration
-
-The collector (optionally) reads a configuration file named `/etc/netdata/node.d/named.conf`, with the following contents:
-
-```js
-{
- "enable_autodetect": true,
- "update_every": 5,
- "servers": [
- {
- "name": "bind1",
- "url": "http://127.0.0.1:8888/json/v1/server",
- "update_every": 1
- },
- {
- "name": "bind2",
- "url": "http://10.1.2.3:8888/json/v1/server",
- "update_every": 2
- }
- ]
-}
-```
-
-You can add any number of bind servers.
-
-If the configuration file is missing, or the key `enable_autodetect` is `true`, the collector will also attempt to fetch `http://localhost:8888/json/v1/server` which, if successful will be added too.
-
-### XML instead of JSON, from bind
-
-The collector can also accept bind URLs that return XML output. This might required if you cannot have bind 9.10+ with JSON but you have an version of bind that supports XML statistics v3. Check [this](https://www.isc.org/blogs/bind-9-10-statistics-troubleshooting-and-zone-configuration/) for versions supported.
-
-In such cases, use a URL like this:
-
-```sh
-curl "http://localhost:8888/xml/v3/server"
-```
-
-Only `xml` and `v3` has been tested.
-
-Keep in mind though, that XML parsing is done using javascript code, which requires a triple conversion:
-
-1. from XML to JSON using a javascript XML parser (**CPU intensive**),
-2. which is then transformed to emulate the output of the JSON output of bind (**CPU intensive** - and yes the converted JSON from XML is different to the native JSON - even bind produces different names for various attributes),
-3. which is then processed to generate the data for the charts (this will happen even if bind is producing JSON).
-
-In general, expect XML parsing to be 2 to 3 times more CPU intensive than JSON.
-
-**So, if you can use the JSON output of bind, prefer it over XML**. Keep also in mind that even bind will use more CPU when generating XML instead of JSON.
-
-The XML interface of bind is not autodetected.
-You will have to provide the config file `/etc/netdata/node.d/named.conf`, like this:
-
-```js
-{
- "enable_autodetect": false,
- "update_every": 1,
- "servers": [
- {
- "name": "local",
- "url": "http://localhost:8888/xml/v3/server",
- "update_every": 1
- }
- ]
-}
-```
-
-Of course, you can monitor more than one bind servers. Each one can be configured with either JSON or XML output.
-
-## Auto-detection
-
-Auto-detection is controlled by `enable_autodetect` in the config file. The default is enabled, so that if the collector can connect to `http://localhost:8888/json/v1/server` to receive bind statistics, it will automatically enable it.
-
-## Bind (named) configuration
-
-To use this plugin, you have to have bind v9.10+ properly compiled to provide statistics in `JSON` format.
-
-For more information on how to get your bind installation ready, please refer to the [bind statistics channel developer comments](http://jpmens.net/2013/03/18/json-in-bind-9-s-statistics-server/) and to [bind documentation](https://ftp.isc.org/isc/bind/9.10.3/doc/arm/Bv9ARM.ch06.html#statistics) or [bind Knowledge Base article AA-01123](https://kb.isc.org/article/AA-01123/0).
-
-Normally, you will need something like this in your `named.conf`:
-
-```
-statistics-channels {
- inet 127.0.0.1 port 8888 allow { 127.0.0.1; };
- inet ::1 port 8888 allow { ::1; };
-};
-```
-
-(use the IPv4 or IPv6 line depending on what you are using, you can also use both)
-
-Verify it works by running the following command (the collector is written in node.js and will query your bind server directly, but if this command works, the collector should be able to work too):
-
-```sh
-curl "http://localhost:8888/json/v1/server"
-```
-
-
-[]()
+# ISC Bind Statistics + +Using this Netdata collector, you can monitor one or more ISC Bind servers. + +## Example Netdata charts + +Depending on the number of views your bind has, you may get a large number of charts. +Here this is with just one view: + + + + +## How it works + +The plugin will execute (from within node.js) the equivalent of: + +```sh +curl "http://localhost:8888/json/v1/server" +``` + +Here is a sample of the output this command produces. + +```js +{ + "json-stats-version":"1.0", + "boot-time":"2016-01-31T08:20:48Z", + "config-time":"2016-01-31T09:28:03Z", + "current-time":"2016-02-02T22:22:20Z", + "opcodes":{ + "QUERY":247816, + "IQUERY":0, + "STATUS":0, + "RESERVED3":0, + "NOTIFY":0, + "UPDATE":3813, + "RESERVED6":0, + "RESERVED7":0, + "RESERVED8":0, + "RESERVED9":0, + "RESERVED10":0, + "RESERVED11":0, + "RESERVED12":0, + "RESERVED13":0, + "RESERVED14":0, + "RESERVED15":0 + }, + "qtypes":{ + "A":89519, + "NS":863, + "CNAME":1, + "SOA":1, + "PTR":116779, + "MX":276, + "TXT":198, + "AAAA":39324, + "SRV":850, + "ANY":5 + }, + "nsstats":{ + "Requestv4":251630, + "ReqEdns0":1255, + "ReqTSIG":3813, + "ReqTCP":57, + "AuthQryRej":1455, + "RecQryRej":122, + "Response":245918, + "TruncatedResp":44, + "RespEDNS0":1255, + "RespTSIG":3813, + "QrySuccess":205159, + "QryAuthAns":119495, + "QryNoauthAns":120770, + "QryNxrrset":32711, + "QrySERVFAIL":262, + "QryNXDOMAIN":2395, + "QryRecursion":40885, + "QryDuplicate":5712, + "QryFailure":1577, + "UpdateDone":2514, + "UpdateFail":1299, + "UpdateBadPrereq":1276, + "QryUDP":246194, + "QryTCP":45, + "OtherOpt":101 + }, + "views":{ + "local":{ + "resolver":{ + "stats":{ + "Queryv4":74577, + "Responsev4":67032, + "NXDOMAIN":601, + "SERVFAIL":5, + "FORMERR":7, + "EDNS0Fail":7, + "Truncated":3071, + "Lame":4, + "Retry":11826, + "QueryTimeout":1838, + "GlueFetchv4":6864, + "GlueFetchv4Fail":30, + "QryRTT10":112, + "QryRTT100":42900, + "QryRTT500":23275, + "QryRTT800":534, + "QryRTT1600":97, + "QryRTT1600+":20, + "BucketSize":31, + "REFUSED":13 + }, + "qtypes":{ + "A":64931, + "NS":870, + "CNAME":185, + "PTR":5, + "MX":49, + "TXT":149, + "AAAA":7972, + "SRV":416 + }, + "cache":{ + "A":40356, + "NS":8032, + "CNAME":14477, + "PTR":2, + "MX":21, + "TXT":32, + "AAAA":3301, + "SRV":94, + "DS":237, + "RRSIG":2301, + "NSEC":126, + "!A":52, + "!NS":4, + "!TXT":1, + "!AAAA":3797, + "!SRV":9, + "NXDOMAIN":590 + }, + "cachestats":{ + "CacheHits":1085188, + "CacheMisses":109, + "QueryHits":464755, + "QueryMisses":55624, + "DeleteLRU":0, + "DeleteTTL":42615, + "CacheNodes":5188, + "CacheBuckets":2079, + "TreeMemTotal":2326026, + "TreeMemInUse":1508075, + "HeapMemMax":132096, + "HeapMemTotal":393216, + "HeapMemInUse":132096 + }, + "adb":{ + "nentries":1021, + "entriescnt":3157, + "nnames":1021, + "namescnt":3022 + } + } + }, + "public":{ + "resolver":{ + "stats":{ + "BucketSize":31 + }, + "qtypes":{ + }, + "cache":{ + }, + "cachestats":{ + "CacheHits":0, + "CacheMisses":0, + "QueryHits":0, + "QueryMisses":0, + "DeleteLRU":0, + "DeleteTTL":0, + "CacheNodes":0, + "CacheBuckets":64, + "TreeMemTotal":287392, + "TreeMemInUse":29608, + "HeapMemMax":1024, + "HeapMemTotal":262144, + "HeapMemInUse":1024 + }, + "adb":{ + "nentries":1021, + "nnames":1021 + } + } + }, + "_bind":{ + "resolver":{ + "stats":{ + "BucketSize":31 + }, + "qtypes":{ + }, + "cache":{ + }, + "cachestats":{ + "CacheHits":0, + "CacheMisses":0, + "QueryHits":0, + "QueryMisses":0, + "DeleteLRU":0, + "DeleteTTL":0, + "CacheNodes":0, + "CacheBuckets":64, + "TreeMemTotal":287392, + "TreeMemInUse":29608, + "HeapMemMax":1024, + "HeapMemTotal":262144, + "HeapMemInUse":1024 + }, + "adb":{ + "nentries":1021, + "nnames":1021 + } + } + } + } +} +``` + +From this output it collects: + +- Global Received Requests by IP version (IPv4, IPv6) +- Global Successful Queries +- Current Recursive Clients +- Global Queries by IP Protocol (TCP, UDP) +- Global Queries Analysis +- Global Received Updates +- Global Query Failures +- Global Query Failures Analysis +- Other Global Server Statistics +- Global Incoming Requests by OpCode +- Global Incoming Requests by Query Type +- Global Socket Statistics (will only work if the url is `http://127.0.0.1:8888/json/v1`, i.e. without `/server`, but keep in mind this produces a very long output and probably will account for 0.5% CPU overhead alone, per bind server added) +- Per View Statistics (the following set will be added for each bind view): + - View, Resolver Active Queries + - View, Resolver Statistics + - View, Resolver Round Trip Timings + - View, Requests by Query Type + +## Configuration + +The collector (optionally) reads a configuration file named `/etc/netdata/node.d/named.conf`, with the following contents: + +```js +{ + "enable_autodetect": true, + "update_every": 5, + "servers": [ + { + "name": "bind1", + "url": "http://127.0.0.1:8888/json/v1/server", + "update_every": 1 + }, + { + "name": "bind2", + "url": "http://10.1.2.3:8888/json/v1/server", + "update_every": 2 + } + ] +} +``` + +You can add any number of bind servers. + +If the configuration file is missing, or the key `enable_autodetect` is `true`, the collector will also attempt to fetch `http://localhost:8888/json/v1/server` which, if successful will be added too. + +### XML instead of JSON, from bind + +The collector can also accept bind URLs that return XML output. This might required if you cannot have bind 9.10+ with JSON but you have an version of bind that supports XML statistics v3. Check [this](https://www.isc.org/blogs/bind-9-10-statistics-troubleshooting-and-zone-configuration/) for versions supported. + +In such cases, use a URL like this: + +```sh +curl "http://localhost:8888/xml/v3/server" +``` + +Only `xml` and `v3` has been tested. + +Keep in mind though, that XML parsing is done using javascript code, which requires a triple conversion: + +1. from XML to JSON using a javascript XML parser (**CPU intensive**), +2. which is then transformed to emulate the output of the JSON output of bind (**CPU intensive** - and yes the converted JSON from XML is different to the native JSON - even bind produces different names for various attributes), +3. which is then processed to generate the data for the charts (this will happen even if bind is producing JSON). + +In general, expect XML parsing to be 2 to 3 times more CPU intensive than JSON. + +**So, if you can use the JSON output of bind, prefer it over XML**. Keep also in mind that even bind will use more CPU when generating XML instead of JSON. + +The XML interface of bind is not autodetected. +You will have to provide the config file `/etc/netdata/node.d/named.conf`, like this: + +```js +{ + "enable_autodetect": false, + "update_every": 1, + "servers": [ + { + "name": "local", + "url": "http://localhost:8888/xml/v3/server", + "update_every": 1 + } + ] +} +``` + +Of course, you can monitor more than one bind servers. Each one can be configured with either JSON or XML output. + +## Auto-detection + +Auto-detection is controlled by `enable_autodetect` in the config file. The default is enabled, so that if the collector can connect to `http://localhost:8888/json/v1/server` to receive bind statistics, it will automatically enable it. + +## Bind (named) configuration + +To use this plugin, you have to have bind v9.10+ properly compiled to provide statistics in `JSON` format. + +For more information on how to get your bind installation ready, please refer to the [bind statistics channel developer comments](http://jpmens.net/2013/03/18/json-in-bind-9-s-statistics-server/) and to [bind documentation](https://ftp.isc.org/isc/bind/9.10.3/doc/arm/Bv9ARM.ch06.html#statistics) or [bind Knowledge Base article AA-01123](https://kb.isc.org/article/AA-01123/0). + +Normally, you will need something like this in your `named.conf`: + +``` +statistics-channels { + inet 127.0.0.1 port 8888 allow { 127.0.0.1; }; + inet ::1 port 8888 allow { ::1; }; +}; +``` + +(use the IPv4 or IPv6 line depending on what you are using, you can also use both) + +Verify it works by running the following command (the collector is written in node.js and will query your bind server directly, but if this command works, the collector should be able to work too): + +```sh +curl "http://localhost:8888/json/v1/server" +``` + +[](<>) diff --git a/collectors/node.d.plugin/sma_webbox/README.md b/collectors/node.d.plugin/sma_webbox/README.md index e0d5e4adee..2969756261 100644 --- a/ |