summaryrefslogtreecommitdiffstats
path: root/collectors/charts.d.plugin
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2019-08-13 08:07:17 -0700
committerGitHub <noreply@github.com>2019-08-13 08:07:17 -0700
commita726c905bde122d6a03da9866efb51a2e3b526c2 (patch)
tree7715d332b0eeedbf4e45ea60c698a25c2c30929d /collectors/charts.d.plugin
parentdc38b1d15df2d07f65c0f3c8f8f944fbcc89a574 (diff)
Change "netdata" to "Netdata" in all docs (#6621)
* First pass of changing netdata to Netdata * Second pass of netdata -> Netdata * Starting work on netdata with no whitespace after * Pass for netdata with no whitespace at the end * Pass for netdata with no whitespace at the front
Diffstat (limited to 'collectors/charts.d.plugin')
-rw-r--r--collectors/charts.d.plugin/README.md24
-rw-r--r--collectors/charts.d.plugin/ap/README.md2
-rw-r--r--collectors/charts.d.plugin/apache/README.md8
-rw-r--r--collectors/charts.d.plugin/sensors/README.md2
4 files changed, 18 insertions, 18 deletions
diff --git a/collectors/charts.d.plugin/README.md b/collectors/charts.d.plugin/README.md
index 3d318f26cf..06fbd46b8b 100644
--- a/collectors/charts.d.plugin/README.md
+++ b/collectors/charts.d.plugin/README.md
@@ -1,10 +1,10 @@
# charts.d.plugin
-`charts.d.plugin` is a netdata external plugin. It is an **orchestrator** for data collection modules written in `BASH` v4+.
+`charts.d.plugin` is a Netdata external plugin. It is an **orchestrator** for data collection modules written in `BASH` v4+.
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**
`charts.d.plugin` has been designed so that the actual script that will do data collection will be permanently in
@@ -43,7 +43,7 @@ For a module called `X`, the following criteria must be met:
2. If the module needs a configuration, it should be called `X.conf` and placed in `/etc/netdata/charts.d`.
The configuration file `X.conf` is also a BASH script itself.
- To edit the default files supplied by netdata run `/etc/netdata/edit-config charts.d/X.conf`,
+ To edit the default files supplied by Netdata, run `/etc/netdata/edit-config charts.d/X.conf`,
where `X` is the name of the module.
3. All functions and global variables defined in the script and its configuration, must begin with `X_`.
@@ -54,11 +54,11 @@ For a module called `X`, the following criteria must be met:
(following the standard Linux command line return codes: 0 = OK, the collector can operate and 1 = FAILED,
the collector cannot be used).
- - `X_create()` - creates the netdata charts, following the standard netdata plugin guides as described in
+ - `X_create()` - creates the Netdata charts, following the standard Netdata plugin guides as described in
**[External Plugins](../plugins.d/)** (commands `CHART` and `DIMENSION`).
The return value does matter: 0 = OK, 1 = FAILED.
- - `X_update()` - collects the values for the defined charts, following the standard netdata plugin guides
+ - `X_update()` - collects the values for the defined charts, following the standard Netdata plugin guides
as described in **[External Plugins](../plugins.d/)** (commands `BEGIN`, `SET`, `END`).
The return value also matters: 0 = OK, 1 = FAILED.
@@ -67,7 +67,7 @@ For a module called `X`, the following criteria must be met:
The module script may use more functions or variables. But all of them must begin with `X_`.
-The standard netdata plugin variables are also available (check **[External Plugins](../plugins.d/)**).
+The standard Netdata plugin variables are also available (check **[External Plugins](../plugins.d/)**).
### X_check()
@@ -80,7 +80,7 @@ connect to a local mysql database to find out if it can read the values it needs
### X_create()
-The purpose of the BASH function `X_create()` is to create the charts and dimensions using the standard netdata
+The purpose of the BASH function `X_create()` is to create the charts and dimensions using the standard Netdata
plugin guides (**[External Plugins](../plugins.d/)**).
`X_create()` will be called just once and only after `X_check()` was successful.
@@ -90,8 +90,8 @@ A non-zero return value will disable the collector.
### X_update()
-`X_update()` will be called repeatedly every `X_update_every` seconds, to collect new values and send them to netdata,
-following the netdata plugin guides (**[External Plugins](../plugins.d/)**).
+`X_update()` will be called repeatedly every `X_update_every` seconds, to collect new values and send them to Netdata,
+following the Netdata plugin guides (**[External Plugins](../plugins.d/)**).
The function will be called with one parameter: microseconds since the last time it was run. This value should be
appended to the `BEGIN` statement of every chart updated by the collector script.
@@ -167,7 +167,7 @@ Keep in mind that if your configs are not in `/etc/netdata`, you should do the f
export NETDATA_USER_CONFIG_DIR="/path/to/etc/netdata"
```
-Also, remember that netdata runs `chart.d.plugin` as user `netdata` (or any other user netdata is configured to run as).
+Also, remember that Netdata runs `chart.d.plugin` as user `netdata` (or any other user the `netdata` process is configured to run as).
## Running multiple instances of charts.d.plugin
@@ -188,7 +188,7 @@ This is what you need to do:
3. link `/usr/libexec/netdata/plugins.d/charts.d.plugin` to `/usr/libexec/netdata/plugins.d/charts2.d.plugin`.
Netdata will spawn a new charts.d process.
-Execute the above in this order, since netdata will (by default) attempt to start new plugins soon after they are
+Execute the above in this order, since Netdata will (by default) attempt to start new plugins soon after they are
created in `/usr/libexec/netdata/plugins.d/`.
diff --git a/collectors/charts.d.plugin/ap/README.md b/collectors/charts.d.plugin/ap/README.md
index 962a8565eb..0db77fd922 100644
--- a/collectors/charts.d.plugin/ap/README.md
+++ b/collectors/charts.d.plugin/ap/README.md
@@ -2,7 +2,7 @@
The `ap` collector visualizes data related to access points.
-## Example netdata charts
+## Example Netdata charts
![image](https://cloud.githubusercontent.com/assets/2662304/12377654/9f566e88-bd2d-11e5-855a-e0ba96b8fd98.png)
diff --git a/collectors/charts.d.plugin/apache/README.md b/collectors/charts.d.plugin/apache/README.md
index 273979107c..6632629ee9 100644
--- a/collectors/charts.d.plugin/apache/README.md
+++ b/collectors/charts.d.plugin/apache/README.md
@@ -7,7 +7,7 @@
The `apache` collector visualizes key performance data for an apache web server.
-## Example netdata charts
+## Example Netdata charts
For apache 2.2:
@@ -80,7 +80,7 @@ From the apache status output it collects:
- total accesses (incremental value, rendered as requests/s)
- total bandwidth (incremental value, rendered as bandwidth/s)
- - requests per second (this appears to be calculated by apache as an average for its lifetime, while the one calculated by netdata using the total accesses counter is real-time)
+ - requests per second (this appears to be calculated by apache as an average for its lifetime, while the one calculated by Netdata using the total accesses counter is real-time)
- bytes per second (average for the lifetime of the apache server)
- bytes per request (average for the lifetime of the apache server)
- workers by status (`busy` and `idle`)
@@ -106,7 +106,7 @@ apache_curl_opts=
apache_update_every=
```
-The default `apache_update_every` is configured in netdata.
+The default `apache_update_every` is configured in Netdata.
## Auto-detection
@@ -122,7 +122,7 @@ If you are able to run successfully, by hand this command:
curl "http://127.0.0.1:80/server-status?auto"
```
-netdata will be able to do it too.
+Netdata will be able to do it too.
Notice: You may need to have the default `000-default.conf ` website enabled in order for the status mod to work.
diff --git a/collectors/charts.d.plugin/sensors/README.md b/collectors/charts.d.plugin/sensors/README.md
index 4f3e46d671..415e0a9717 100644
--- a/collectors/charts.d.plugin/sensors/README.md
+++ b/collectors/charts.d.plugin/sensors/README.md
@@ -13,7 +13,7 @@ The plugin will provide charts for all configured system sensors
> kernel provided values, this plugin will not perform.
> So, the values graphed, are the raw hardware values of the sensors.
-The plugin will create netdata charts for:
+The plugin will create Netdata charts for:
1. **Temperature**
2. **Voltage**