diff options
| author | Joel Hans <joel@netdata.cloud> | 2021-01-07 11:44:43 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-07 11:44:43 -0700 |
| commit | 46a8075c8ff6da974d1b39f5b3b9eb50385892c1 (patch) | |
| tree | 53ee29b1928ef3d13a3c941c52c9f56868bf918c /collectors | |
| parent | 0bb7a429b619bc68104983691e4f957482630787 (diff) | |
Docs housekeeping for SEO and syntax, part 1 (#10388)
* First pass to get the script working right
* Finish adding analytics tags
Diffstat (limited to 'collectors')
27 files changed, 29 insertions, 51 deletions
diff --git a/collectors/QUICKSTART.md b/collectors/QUICKSTART.md index e0f1ccecd7..a691ffc4c3 100644 --- a/collectors/QUICKSTART.md +++ b/collectors/QUICKSTART.md @@ -1,8 +1,6 @@ <!-- ---- title: "Collectors quickstart" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/QUICKSTART.md ---- --> # Collectors quickstart @@ -123,3 +121,5 @@ popular collectors. Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our [internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin docs](/collectors/plugins.d/README.md). + +[]() diff --git a/collectors/README.md b/collectors/README.md index 5fed208c9c..ef1f9610c1 100644 --- a/collectors/README.md +++ b/collectors/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "Collecting metrics" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/README.md ---- --> # Collecting metrics diff --git a/collectors/REFERENCE.md b/collectors/REFERENCE.md index a49c838859..08a405dc7b 100644 --- a/collectors/REFERENCE.md +++ b/collectors/REFERENCE.md @@ -1,8 +1,6 @@ <!-- ---- title: "Collectors configuration reference" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md ---- --> # Collectors configuration reference @@ -184,3 +182,5 @@ through this, is to examine what other similar plugins do. ## Write a custom collector You can add custom collectors by following the [external plugins documentation](../collectors/plugins.d/). + +[]() diff --git a/collectors/cgroups.plugin/README.md b/collectors/cgroups.plugin/README.md index 853c0f5946..9b26deb2ce 100644 --- a/collectors/cgroups.plugin/README.md +++ b/collectors/cgroups.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "cgroups.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md ---- --> # cgroups.plugin diff --git a/collectors/checks.plugin/README.md b/collectors/checks.plugin/README.md index 57de81e1c1..5f1a6b912b 100644 --- a/collectors/checks.plugin/README.md +++ b/collectors/checks.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "checks.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/checks.plugin/README.md ---- --> # checks.plugin diff --git a/collectors/cups.plugin/README.md b/collectors/cups.plugin/README.md index 1d52f09e68..373602dca1 100644 --- a/collectors/cups.plugin/README.md +++ b/collectors/cups.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "cups.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md ---- --> # cups.plugin @@ -60,3 +58,5 @@ For each destination the plugin provides these charts: - processing At the moment only job status pending, processing, and held are reported because we do not have a method to collect stopped, canceled, aborted and completed jobs which scales. + +[]() diff --git a/collectors/diskspace.plugin/README.md b/collectors/diskspace.plugin/README.md index 8f814018ac..a8b41c861d 100644 --- a/collectors/diskspace.plugin/README.md +++ b/collectors/diskspace.plugin/README.md @@ -1,8 +1,7 @@ <!-- ---- title: "diskspace.plugin" +description: "Monitor the disk usage space of mounted disks in real-time with the Netdata Agent, plus preconfigured alarms for disks at risk of filling up." custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md ---- --> # diskspace.plugin diff --git a/collectors/fping.plugin/README.md b/collectors/fping.plugin/README.md index ad12faaca1..4aca2a9de3 100644 --- a/collectors/fping.plugin/README.md +++ b/collectors/fping.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "fping.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/fping.plugin/README.md ---- --> # fping.plugin diff --git a/collectors/freebsd.plugin/README.md b/collectors/freebsd.plugin/README.md index 47090b29ed..1b519a6594 100644 --- a/collectors/freebsd.plugin/README.md +++ b/collectors/freebsd.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "freebsd.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md ---- --> # freebsd.plugin diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md index 7ea57ed8ac..64328fc9e7 100644 --- a/collectors/freeipmi.plugin/README.md +++ b/collectors/freeipmi.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "freeipmi.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md ---- --> # freeipmi.plugin diff --git a/collectors/idlejitter.plugin/README.md b/collectors/idlejitter.plugin/README.md index 139b9b1690..3703e2ee25 100644 --- a/collectors/idlejitter.plugin/README.md +++ b/collectors/idlejitter.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "idlejitter.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md ---- --> # idlejitter.plugin diff --git a/collectors/ioping.plugin/README.md b/collectors/ioping.plugin/README.md index a48511c005..08b0ce8b15 100644 --- a/collectors/ioping.plugin/README.md +++ b/collectors/ioping.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "ioping.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md ---- --> # ioping.plugin diff --git a/collectors/macos.plugin/README.md b/collectors/macos.plugin/README.md index 7e61efcd04..800eb0e85e 100644 --- a/collectors/macos.plugin/README.md +++ b/collectors/macos.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "macos.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md ---- --> # macos.plugin diff --git a/collectors/nfacct.plugin/README.md b/collectors/nfacct.plugin/README.md index ac5092f2ae..1bd8a46e8f 100644 --- a/collectors/nfacct.plugin/README.md +++ b/collectors/nfacct.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "nfacct.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md ---- --> # nfacct.plugin diff --git a/collectors/perf.plugin/README.md b/collectors/perf.plugin/README.md index 2131e71671..d4bb41cb60 100644 --- a/collectors/perf.plugin/README.md +++ b/collectors/perf.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "perf.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md ---- --> # perf.plugin diff --git a/collectors/plugins.d/README.md b/collectors/plugins.d/README.md index 3ce463e228..913ad9177c 100644 --- a/collectors/plugins.d/README.md +++ b/collectors/plugins.d/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "External plugins overview" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md ---- --> # External plugins overview diff --git a/collectors/proc.plugin/README.md b/collectors/proc.plugin/README.md index 6a8dc71142..085afb4fb6 100644 --- a/collectors/proc.plugin/README.md +++ b/collectors/proc.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "proc.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md ---- --> # proc.plugin diff --git a/collectors/python.d.plugin/alarms/README.md b/collectors/python.d.plugin/alarms/README.md index ea90529529..ea96061cc7 100644 --- a/collectors/python.d.plugin/alarms/README.md +++ b/collectors/python.d.plugin/alarms/README.md @@ -54,3 +54,5 @@ local: ``` It will default to pulling all alarms at each time step from the Netdata rest api at `http://127.0.0.1:19999/api/v1/alarms?all` + +[]() diff --git a/collectors/python.d.plugin/am2320/README.md b/collectors/python.d.plugin/am2320/README.md index cfc8a69501..c17b33dfa1 100644 --- a/collectors/python.d.plugin/am2320/README.md +++ b/collectors/python.d.plugin/am2320/README.md @@ -50,3 +50,5 @@ Software install: - save the file. - restart the netdata service. - check the dashboard. + +[]() diff --git a/collectors/python.d.plugin/anomalies/README.md b/collectors/python.d.plugin/anomalies/README.md index 95245a450e..487a11a095 100644 --- a/collectors/python.d.plugin/anomalies/README.md +++ b/collectors/python.d.plugin/anomalies/README.md @@ -225,3 +225,5 @@ If you would like to go deeper on what exactly the anomalies collector is doing - [Mendeley public group](https://www.mendeley.com/community/interesting-anomaly-detection-papers/) with some interesting anomaly detection papers we have been reading. - Good [blog post](https://www.anodot.com/blog/what-is-anomaly-detection/) from Anodot on time series anomaly detection. Anodot also have some great whitepapers in this space too that some may find useful. - Novelty and outlier detection in the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html). + +[]() diff --git a/collectors/python.d.plugin/gearman/README.md b/collectors/python.d.plugin/gearman/README.md index 7e96f8fc62..b9fc914bf7 100644 --- a/collectors/python.d.plugin/gearman/README.md +++ b/collectors/python.d.plugin/gearman/README.md @@ -48,4 +48,4 @@ localhost: When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`. ---- +[]() diff --git a/collectors/python.d.plugin/hpssa/README.md b/collectors/python.d.plugin/hpssa/README.md index b1157bf9fa..426f19c536 100644 --- a/collectors/python.d.plugin/hpssa/README.md +++ b/collectors/python.d.plugin/hpssa/README.md @@ -51,3 +51,5 @@ If `ssacli` cannot be found in the `PATH`, configure it in `hpssa.conf`. ```yaml ssacli_path: /usr/sbin/ssacli ``` + +[]() diff --git a/collectors/python.d.plugin/riakkv/README.md b/collectors/python.d.plugin/riakkv/README.md index fe62c67189..d0ea9a1379 100644 --- a/collectors/python.d.plugin/riakkv/README.md +++ b/collectors/python.d.plugin/riakkv/README.md @@ -124,3 +124,5 @@ With no explicit configuration given, the module will attempt to connect to The default update frequency for the plugin is set to 2 seconds as Riak internally updates the metrics every second. If we were to update the metrics every second, the resulting graph would contain odd jitter. + +[]() diff --git a/collectors/slabinfo.plugin/README.md b/collectors/slabinfo.plugin/README.md index 3ba701838d..21d83c999b 100644 --- a/collectors/slabinfo.plugin/README.md +++ b/collectors/slabinfo.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "slabinfo.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md ---- --> # slabinfo.plugin diff --git a/collectors/statsd.plugin/README.md b/collectors/statsd.plugin/README.md index 681d48294f..d5bc0d1ad5 100644 --- a/collectors/statsd.plugin/README.md +++ b/collectors/statsd.plugin/README.md @@ -1,8 +1,7 @@ <!-- ---- title: "statsd.plugin" +description: "The Netdata Agent is a fully-featured statsd server that collects metrics from any custom application and visualizes them in real-time." custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md ---- --> # statsd.plugin @@ -219,7 +218,8 @@ The same chart with the `sum` unselected: ### synthetic statsd charts -Using synthetic charts, you can create dedicated sections on the dashboard to render the charts. You can control everything: the main menu, the submenus, the charts, the dimensions on each chart, etc. +Use synthetic charts to create dedicated sections on the dashboard to render the charts, with control over the main +menu, the submenus, the charts, the dimensions on each chart, and more. Synthetic charts are organized in @@ -229,7 +229,7 @@ Synthetic charts are organized in For each application you need to create a `.conf` file in `/etc/netdata/statsd.d`. -So, to create the statsd application `myapp`, you can create the file `/etc/netdata/statsd.d/myapp.conf`, with this content: +So, to create the statsd application `myapp`, create the file `/etc/netdata/statsd.d/myapp.conf`, with this content: ``` [app] @@ -271,9 +271,9 @@ Using the above configuration `myapp` should get its own section on the dashboar `[dictionary]` defines name-value associations. These are used to renaming metrics, when added to synthetic charts. Metric names are also defined at each `dimension` line. However, using the dictionary dimension names can be declared globally, for each app and is the only way to rename dimensions when using patterns. Of course the dictionary can be empty or missing. -Then, you can add any number of charts. Each chart should start with `[id]`. The chart will be called `app_name.id`. `family` controls the submenu on the dashboard. `context` controls the alarm templates. `priority` controls the ordering of the charts on the dashboard. The rest of the settings are informational. +Then, add any number of charts. Each chart should start with `[id]`. The chart will be called `app_name.id`. `family` controls the submenu on the dashboard. `context` controls the alarm templates. `priority` controls the ordering of the charts on the dashboard. The rest of the settings are informational. -You can add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters: +Add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters: 1. the metric name, as it is collected (it has to be matched by the `metrics =` pattern of the app) 2. the dimension name, as it should be shown on the chart @@ -351,12 +351,12 @@ Netdata uses this dictionary as follows: 3. If any of the above succeeds, Netdata uses the `value` of the dictionary, to set the name of the dimension. The dimensions will have as ID the original statsd metric name, and as name, the dictionary value. -So, you can use the dictionary in 2 ways: +Use the dictionary in 2 ways: 1. set `dimension = myapp.metric1 ''` and have at the dictionary `myapp.metric1 = metric1 name` 2. set `dimension = myapp.metric1 'm1'` and have at the dictionary `m1 = metric1 name` -In both cases, the dimension will be added with ID `myapp.metric1` and will be named `metric1 name`. So, in alarms you can use either of the 2 as `${myapp.metric1}` or `${metric1 name}`. +In both cases, the dimension will be added with ID `myapp.metric1` and will be named `metric1 name`. So, in alarms use either of the 2 as `${myapp.metric1}` or `${metric1 name}`. > keep in mind that if you add multiple times the same statsd metric to a chart, Netdata will append `TYPE` to the dimension ID, so `myapp.metric1` will be added as `myapp.metric1_last` or `myapp.metric1_events`, etc. If you add multiple times the same metric with the same `TYPE` to a chart, Netdata will also append an incremental counter to the dimension ID, i.e. `myapp.metric1_last1`, `myapp.metric1_last2`, etc. @@ -389,7 +389,7 @@ To add all response codes of `myapp.api.get` to a chart use this: dimension = pattern 'myapp.api.get.* '' last 1 1 ``` -The above will add dimension named `200`, `400` and `500` (yes, Netdata extracts the wildcarded part of the metric name - so the dimensions will be named with whatever the `*` matched). You can rename the dimensions with this: +The above will add dimension named `200`, `400` and `500` (yes, Netdata extracts the wildcarded part of the metric name - so the dimensions will be named with whatever the `*` matched). Rename the dimensions with this: ``` [dictionary] @@ -451,7 +451,8 @@ Using the above, the dimensions will be added as `GET`, `ADD` and `DELETE`. ## sending statsd metrics from shell scripts -You can send/update statsd metrics from shell scripts. You can use this feature, to visualize in Netdata automated jobs you run on your servers. +Send/update statsd metrics from shell scripts to visualize automated jobs you run on your servers using the Netdata +Agent. The command you need to run is: diff --git a/collectors/tc.plugin/README.md b/collectors/tc.plugin/README.md index 3ef47c11a8..70e31c236b 100644 --- a/collectors/tc.plugin/README.md +++ b/collectors/tc.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "tc.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md ---- --> # tc.plugin diff --git a/collectors/xenstat.plugin/README.md b/collectors/xenstat.plugin/README.md index 7d79d41faf..61be271d99 100644 --- a/collectors/xenstat.plugin/README.md +++ b/collectors/xenstat.plugin/README.md @@ -1,8 +1,6 @@ <!-- ---- title: "xenstat.plugin" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md ---- --> # xenstat.plugin |