diff options
author | Joel Hans <joel@netdata.cloud> | 2020-04-14 10:26:13 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-04-14 10:26:13 -0700 |
commit | e99692f145f710930723081d2e5bbf8868be2080 (patch) | |
tree | 468157463f0f133d927019e6826a9559dd989b9b /collectors/charts.d.plugin/README.md | |
parent | 59916b01b83026d6e6caf59f4efb67b7d428b70d (diff) |
Docs: Standardize links between documentation (#8638)
* Trying out some absolute-ish links
* Try one out on installer
* Testing logic
* Trying out some more links
* Fixing links
* Fix links in python collectors
* Changed a bunch more links
* Fix build errors
* Another push of links
* Fix build error and add more links
* Complete first pass
* Fix final broken links
* Fix links to files
* Fix for Netlify
* Two more fixes
Diffstat (limited to 'collectors/charts.d.plugin/README.md')
-rw-r--r-- | collectors/charts.d.plugin/README.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/collectors/charts.d.plugin/README.md b/collectors/charts.d.plugin/README.md index b6b52b2161..0067f25f0c 100644 --- a/collectors/charts.d.plugin/README.md +++ b/collectors/charts.d.plugin/README.md @@ -62,11 +62,11 @@ For a module called `X`, the following criteria must be met: the collector cannot be used). - `X_create()` - creates the Netdata charts, following the standard Netdata plugin guides as described in - **[External Plugins](../plugins.d/)** (commands `CHART` and `DIMENSION`). + **[External Plugins](/collectors/plugins.d/README.md)** (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 - as described in **[External Plugins](../plugins.d/)** (commands `BEGIN`, `SET`, `END`). + as described in **[External Plugins](/collectors/plugins.d/README.md)** (commands `BEGIN`, `SET`, `END`). The return value also matters: 0 = OK, 1 = FAILED. 5. The following global variables are available to be set: @@ -74,7 +74,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](/collectors/plugins.d/README.md)**). ### X_check() @@ -88,7 +88,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 -plugin guides (**[External Plugins](../plugins.d/)**). +plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**). `X_create()` will be called just once and only after `X_check()` was successful. You can however call it yourself when there is need for it (for example to add a new dimension to an existing chart). @@ -98,7 +98,7 @@ 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/)**). +following the Netdata plugin guides (**[External Plugins](/collectors/plugins.d/README.md)**). 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. |