diff options
Diffstat (limited to 'collectors/node.d.plugin')
| -rw-r--r-- | collectors/node.d.plugin/README.md | 16 | ||||
| -rw-r--r-- | collectors/node.d.plugin/fronius/README.md | 4 | ||||
| -rw-r--r-- | collectors/node.d.plugin/named/README.md | 8 | ||||
| -rw-r--r-- | collectors/node.d.plugin/sma_webbox/README.md | 2 | ||||
| -rw-r--r-- | collectors/node.d.plugin/snmp/README.md | 8 | ||||
| -rw-r--r-- | collectors/node.d.plugin/stiebeleltron/README.md | 2 |
6 files changed, 20 insertions, 20 deletions
diff --git a/collectors/node.d.plugin/README.md b/collectors/node.d.plugin/README.md index 265b1ac56d..fb7dce6bd2 100644 --- a/collectors/node.d.plugin/README.md +++ b/collectors/node.d.plugin/README.md @@ -1,10 +1,10 @@ # node.d.plugin -`node.d.plugin` is a netdata external plugin. It is an **orchestrator** for data collection modules written in `node.js`. +`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) +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 @@ -28,7 +28,7 @@ At minimum, to be buildable and testable, the PR needs to include: Node.js is perfect for asynchronous operations. It is very fast and quite common (actually the whole web is based on it). Since data collection is not a CPU intensive task, node.js is an ideal solution for it. -`node.d.plugin` is a netdata plugin that provides an abstraction layer to allow easy and quick development of data +`node.d.plugin` is a Netdata plugin that provides an abstraction layer to allow easy and quick development of data collectors in node.js. It also manages all its data collectors (placed in `/usr/libexec/netdata/node.d`) using a single instance of node, thus lowering the memory footprint of data collection. @@ -54,7 +54,7 @@ For more information check the **[[Installation]]** guide. 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 +`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. @@ -93,7 +93,7 @@ Your data collection module should be split in 3 parts: 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. + 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 @@ -127,7 +127,7 @@ netdata.processors.myprocessor = { var mymodule = { processResponse: function(service, data) { - /* send information to the netdata server here */ + /* send information to the Netdata server here */ }, @@ -221,7 +221,7 @@ The configuration file `/etc/netdata/node.d/mymodule.conf` may contain whatever `data` may be `null` or whatever the processor specified in the `service` returned. -The `service` object defines a set of functions to allow you send information to the netdata core about: +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 diff --git a/collectors/node.d.plugin/fronius/README.md b/collectors/node.d.plugin/fronius/README.md index 72522637c0..c70e7f72ee 100644 --- a/collectors/node.d.plugin/fronius/README.md +++ b/collectors/node.d.plugin/fronius/README.md @@ -3,7 +3,7 @@ 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`) + * 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: @@ -61,7 +61,7 @@ The plugin has been tested with a single inverter, namely Fronius Symo 8.2-3-M: 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. +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 { diff --git a/collectors/node.d.plugin/named/README.md b/collectors/node.d.plugin/named/README.md index 480cbc199f..b3f7eaaf21 100644 --- a/collectors/node.d.plugin/named/README.md +++ b/collectors/node.d.plugin/named/README.md @@ -1,8 +1,8 @@ # ISC Bind Statistics
-Using this netdata collector, you can monitor one or more ISC Bind servers.
+Using this Netdata collector, you can monitor one or more ISC Bind servers.
-## Example netdata charts
+## 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:
@@ -340,5 +340,5 @@ Verify it works by running the following command (the collector is written in no 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 cff7645df7..e0d5e4adee 100644 --- a/collectors/node.d.plugin/sma_webbox/README.md +++ b/collectors/node.d.plugin/sma_webbox/README.md @@ -3,7 +3,7 @@ [SMA Sunny Webbox](http://files.sma.de/dl/4253/WEBBOX-DUS131916W.pdf)
-Example netdata configuration for node.d/sma_webbox.conf
+Example Netdata configuration for node.d/sma_webbox.conf
The module supports any number of name servers, like this:
diff --git a/collectors/node.d.plugin/snmp/README.md b/collectors/node.d.plugin/snmp/README.md index 832108b94c..9012b3400c 100644 --- a/collectors/node.d.plugin/snmp/README.md +++ b/collectors/node.d.plugin/snmp/README.md @@ -1,6 +1,6 @@ # SNMP Data Collector -Using this collector, netdata can collect data from any SNMP device. +Using this collector, Netdata can collect data from any SNMP device. This collector supports: @@ -88,7 +88,7 @@ In this example: `update_every` is the update frequency for each server, in seconds. -`max_request_size` limits the maximum number of OIDs that will be requested in a single call. The default is 50. Lower this number of you get `TooBig` errors in netdata error.log. +`max_request_size` limits the maximum number of OIDs that will be requested in a single call. The default is 50. Lower this number of you get `TooBig` errors in Netdata's `error.log`. `family` sets the name of the submenu of the dashboard each chart will appear under. @@ -177,9 +177,9 @@ To test it, you can run: /usr/libexec/netdata/plugins.d/node.d.plugin 1 snmp ``` -The above will run it on your console and you will be able to see what netdata sees, but also errors. You can get a very detailed output by appending `debug` to the command line. +The above will run it on your console and you will be able to see what Netdata sees, but also errors. You can get a very detailed output by appending `debug` to the command line. -If it works, restart netdata to activate the snmp collector and refresh the dashboard (if your SNMP device responds with a delay, you may need to refresh the dashboard in a few seconds). +If it works, restart Netdata to activate the snmp collector and refresh the dashboard (if your SNMP device responds with a delay, you may need to refresh the dashboard in a few seconds). ## Data collection speed diff --git a/collectors/node.d.plugin/stiebeleltron/README.md b/collectors/node.d.plugin/stiebeleltron/README.md index 4aa5a43e88..ed4f18e464 100644 --- a/collectors/node.d.plugin/stiebeleltron/README.md +++ b/collectors/node.d.plugin/stiebeleltron/README.md @@ -3,7 +3,7 @@ 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`) + * 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: |