diff options
| author | Fotis Voutsas <fotis@netdata.cloud> | 2023-04-12 12:22:15 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-12 12:22:15 +0300 |
| commit | e879bded10c97badcb6a344e2c6e47f4406d91da (patch) | |
| tree | 341ebb959898421d0c3e6bf6e45f385e5f95375f | |
| parent | 1e5036625e3dd5736edc37ab084f4df5edc99d45 (diff) | |
Update README.mdcharts.d.plugin-documentation
| -rw-r--r-- | collectors/charts.d.plugin/README.md | 18 |
1 files changed, 4 insertions, 14 deletions
diff --git a/collectors/charts.d.plugin/README.md b/collectors/charts.d.plugin/README.md index 22c43be7d1..3e4edf5625 100644 --- a/collectors/charts.d.plugin/README.md +++ b/collectors/charts.d.plugin/README.md @@ -7,6 +7,9 @@ 3. It communicates with Netdata via a unidirectional pipe (sending data to the `netdata` daemon) 4. Supports any number of data collection **modules** +To better understand the guidelines and the API behind our External plugins, please have a look at the [Introduction to External plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md) prior to reading this page. + + `charts.d.plugin` has been designed so that the actual script that will do data collection will be permanently in memory, collecting data with as little overheads as possible (i.e. initialize once, repeatedly collect values with minimal overhead). @@ -16,16 +19,7 @@ The scripts should have the filename suffix: `.chart.sh`. ## Configuration -> ### Info -> -> This file mentions editing configuration files. -> -> - To edit configuration files in a safe way, we provide the [`edit config` script](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) located in your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically. -> Note that to run the script you need to be inside your Netdata config directory. -> -> It is recommended to use this way for configuring Netdata. - -`charts.d.plugin` itself can be configured using the configuration file `/etc/netdata/charts.d.conf`. This file is also a BASH script. +`charts.d.plugin` itself can be [configured](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) using the configuration file `/etc/netdata/charts.d.conf`. This file is also a BASH script. In this file, you can place statements like this: @@ -43,10 +37,6 @@ The variable `enable_all_charts` sets the default enable/disable state for all c ## A charts.d module -> ### Note -> -> To better understand the guidelines and the API behind our External plugins, please have a look at the [Introduction to External plugins](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md) prior to reading this page. - A `charts.d.plugin` module is a BASH script defining a few functions. For a module called `X`, the following criteria must be met: |