Adding upstream version 1.36.0.upstream/1.36.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 52 insertions, 9 deletions

diff --git a/collectors/plugins.d/README.md b/collectors/plugins.d/README.md
index c84384215..0741636b9 100644
--- a/collectors/plugins.d/README.md
+++ b/collectors/plugins.d/README.md
@@ -116,15 +116,17 @@ For example, if your plugin wants to monitor `squid`, you can search for it on p
 
 Any program that can print a few values to its standard output can become a Netdata external plugin.
 
-Netdata parses 7 lines starting with:
-
--   `CHART` - create or update a chart
--   `DIMENSION` - add or update a dimension to the chart just created
--   `BEGIN` - initialize data collection for a chart
--   `SET` - set the value of a dimension for the initialized chart
--   `END` - complete data collection for the initialized chart
--   `FLUSH` - ignore the last collected values
--   `DISABLE` - disable this plugin
+Netdata parses 9 lines starting with:
+
+-    `CHART` - create or update a chart
+-    `DIMENSION` - add or update a dimension to the chart just created
+-    `BEGIN` - initialize data collection for a chart
+-    `SET` - set the value of a dimension for the initialized chart
+-    `END` - complete data collection for the initialized chart
+-    `FLUSH` - ignore the last collected values
+-    `DISABLE` - disable this plugin
+-    `CLABEL` - add a label to a chart
+-    `CLABEL_COMMIT` - commit added labels to the chart.
 
 a single program can produce any number of charts with any number of dimensions each.
 
@@ -151,6 +153,7 @@ available for the plugin to use.
 |`NETDATA_USER_CONFIG_DIR`|The directory where all Netdata-related user configuration should be stored. If the plugin requires custom user configuration, this is the place the user has saved it (normally under `/etc/netdata`).|
 |`NETDATA_STOCK_CONFIG_DIR`|The directory where all Netdata -related stock configuration should be stored. If the plugin is shipped with configuration files, this is the place they can be found (normally under `/usr/lib/netdata/conf.d`).|
 |`NETDATA_PLUGINS_DIR`|The directory where all Netdata plugins are stored.|
+|`NETDATA_USER_PLUGINS_DIRS`|The list of directories where custom plugins are stored.|
 |`NETDATA_WEB_DIR`|The directory where the web files of Netdata are saved.|
 |`NETDATA_CACHE_DIR`|The directory where the cache files of Netdata are stored. Use this directory if the plugin requires a place to store data. A new directory should be created for the plugin for this purpose, inside this directory.|
 |`NETDATA_LOG_DIR`|The directory where the log files are stored. By default the `stderr` output of the plugin will be saved in the `error.log` file of Netdata.|
@@ -319,6 +322,46 @@ The `value` is floating point (Netdata used `long double`).
 
 Variables are transferred to upstream Netdata servers (streaming and database replication).
 
+#### CLABEL
+
+> CLABEL name value source
+
+`CLABEL` defines a label used to organize and identify a chart.
+
+Name and value accept characters according to the following table:
+
+| Character           | Symbol | Label Name | Label Value |
+|---------------------|:------:|:----------:|:-----------:|
+| UTF-8 character     | UTF-8  |     _      |    keep     |
+| Lower case letter   | [a-z]  |    keep    |    keep     |
+| Upper case letter   | [A-Z]  |    keep    |    [a-z]    |
+| Digit               | [0-9]  |    keep    |    keep     |
+| Underscore          |   _    |    keep    |    keep     |
+| Minus               |   -    |    keep    |    keep     |
+| Plus                |   +    |     _      |    keep     |
+| Colon               |   :    |     _      |    keep     |
+| Semicolon           |   ;    |     _      |      :      |
+| Equal               |   =    |     _      |      :      |
+| Period              |   .    |    keep    |    keep     |
+| Comma               |   ,    |     .      |      .      |
+| Slash               |   /    |    keep    |    keep     |
+| Backslash           |   \    |     /      |      /      |
+| At                  |   @    |     _      |    keep     |
+| Space               |  ' '   |     _      |    keep     |
+| Opening parenthesis |   (    |     _      |    keep     |
+| Closing parenthesis |   )    |     _      |    keep     |
+| Anything else       |        |     _      |      _      |
+
+The `source` is an integer field that can have the following values:
+- `1`: The value was set automatically.
+- `2`: The value was set manually.
+- `4`: This is a K8 label.
+- `8`: This is a label defined using `netdata` agent cloud link.
+
+#### CLABEL_COMMIT
+
+`CLABEL_COMMIT` indicates that all labels were defined and the chart can be updated.
+
 ## Data collection
 
 data collection is defined as a series of `BEGIN` -> `SET` -> `END` lines