Merging upstream version 1.42.0.

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

1 files changed, 212 insertions, 0 deletions

diff --git a/exporting/graphite/metadata.yaml b/exporting/graphite/metadata.yaml
new file mode 100644
index 000000000..ad8c7539b
--- /dev/null
+++ b/exporting/graphite/metadata.yaml
@@ -0,0 +1,212 @@
+# yamllint disable rule:line-length
+---
+- &graphexport
+  id: 'export-graphite'
+  meta: &meta
+    name: 'Graphite'
+    link: 'https://graphite.readthedocs.io/en/latest/'
+    categories:
+      - export
+    icon_filename: 'graphite.png'
+  keywords:
+    - exporter
+    - graphite
+    - remote write
+    - time series
+  overview:
+    exporter_description: |
+      Use the Graphite connector for the exporting engine to archive your Netdata metrics to Graphite providers for long-term storage,
+      further analysis, or correlation with data from other sources.
+    exporter_limitations: ''
+  setup:
+    prerequisites:
+      list:
+        - title: ''
+          description: |
+            - You have already installed Netdata and Graphite.
+    configuration:
+      file:
+        name: 'exporting.conf'
+      options:
+        description: 'The following options can be defined for this exporter.'
+        folding:
+          title: 'Config options'
+          enabled: true
+        list:
+          - name: 'enabled'
+            default_value: 'no'
+            description: 'Enables or disables an exporting connector instance (yes|no).'
+            required: true
+          - name: 'destination'
+            default_value: 'no'
+            description: 'Accepts a space separated list of hostnames, IPs (IPv4 and IPv6) and ports to connect to. Netdata will use the first available to send the metrics.'
+            required: true
+            detailed_description: |
+              The format of each item in this list, is: [PROTOCOL:]IP[:PORT].
+              - PROTOCOL can be udp or tcp. tcp is the default and only supported by the current exporting engine.
+              - IP can be XX.XX.XX.XX (IPv4), or [XX:XX...XX:XX] (IPv6). For IPv6 you can to enclose the IP in [] to separate it from the port.
+              - PORT can be a number of a service name. If omitted, the default port for the exporting connector will be used.
+
+              Example IPv4:
+                ```yaml
+                destination = 10.11.14.2:2003 10.11.14.3:4242 10.11.14.4:2003
+                ```
+              Example IPv6 and IPv4 together:
+              ```yaml
+              destination = [ffff:...:0001]:2003 10.11.12.1:2003
+              ```
+              When multiple servers are defined, Netdata will try the next one when the previous one fails.
+          - name: 'username'
+            default_value: 'my_username'
+            description: 'Username for HTTP authentication'
+            required: false
+          - name: 'password'
+            default_value: 'my_password'
+            description: 'Password for HTTP authentication'
+            required: false
+          - name: 'data source'
+            default_value: ''
+            description: 'Selects the kind of data that will be sent to the external database. (as collected|average|sum)'
+            required: false
+          - name: 'hostname'
+            default_value: '[global].hostname'
+            description: 'The hostname to be used for sending data to the external database server.'
+            required: false
+          - name: 'prefix'
+            default_value: 'netdata'
+            description: 'The prefix to add to all metrics.'
+            required: false
+          - name: 'update every'
+            default_value: '10'
+            description: |
+              Frequency of sending sending data to the external database, in seconds.
+            required: false
+            detailed_description: |
+              Netdata will add some randomness to this number, to prevent stressing the external server when many Netdata servers
+              send data to the same database. This randomness does not affect the quality of the data, only the time they are sent.
+          - name: 'buffer on failures'
+            default_value: '10'
+            description: |
+              The number of iterations (`update every` seconds) to buffer data, when the external database server is not available.
+            required: false
+            detailed_description: |
+              If the server fails to receive the data after that many failures, data loss on the connector instance is expected (Netdata will also log it).
+          - name: 'timeout ms'
+            default_value: '20000'
+            description: 'The timeout in milliseconds to wait for the external database server to process the data.'
+            required: false
+          - name: 'send hosts matching'
+            default_value: 'localhost *'
+            description: |
+              Hosts filter. Determines which hosts will be sent to the external database. The syntax is [simple patterns](https://github.com/netdata/netdata/tree/master/libnetdata/simple_pattern#simple-patterns).
+            required: false
+            detailed_description: |
+              Includes one or more space separated patterns, using * as wildcard (any number of times within each pattern).
+              The patterns are checked against the hostname (the localhost is always checked as localhost), allowing us to
+              filter which hosts will be sent to the external database when this Netdata is a central Netdata aggregating multiple hosts.
+
+              A pattern starting with `!` gives a negative match. So to match all hosts named `*db*` except hosts containing `*child*`,
+              use `!*child* *db*` (so, the order is important: the first pattern matching the hostname will be used - positive or negative).
+          - name: 'send charts matching'
+            default_value: '*'
+            description: |
+              One or more space separated patterns (use * as wildcard) checked against both chart id and chart name.
+            required: false
+            detailed_description: |
+              A pattern starting with ! gives a negative match. So to match all charts named apps.* except charts ending in *reads,
+              use !*reads apps.* (so, the order is important: the first pattern matching the chart id or the chart name will be used,
+              positive or negative). There is also a URL parameter filter that can be used while querying allmetrics. The URL parameter
+              has a higher priority than the configuration option.
+          - name: 'send names instead of ids'
+            default_value: ''
+            description: 'Controls the metric names Netdata should send to the external database (yes|no).'
+            required: false
+            detailed_description: |
+              Netdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and names
+              are human friendly labels (also unique). Most charts and metrics have the same ID and name, but in several cases they are
+              different : disks with device-mapper, interrupts, QoS classes, statsd synthetic charts, etc.
+          - name: 'send configured labels'
+            default_value: ''
+            description: 'Controls if host labels defined in the `[host labels]` section in `netdata.conf` should be sent to the external database (yes|no).'
+            required: false
+          - name: 'send automatic labels'
+            default_value: ''
+            description: 'Controls if automatically created labels, like `_os_name` or `_architecture` should be sent to the external database (yes|no).'
+            required: false
+      examples:
+        folding:
+          enabled: true
+          title: ''
+        list:
+          - name: 'Example configuration'
+            folding:
+              enabled: false
+            description: 'Basic configuration'
+            config: |
+              [graphite:netdata]
+                  enabled = yes
+                  destination = localhost:2003
+          - name: 'Configuration with HTTPS and HTTP authentication'
+            folding:
+              enabled: false
+            description: 'Add `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.'
+            config: |
+              [graphite:netdata]
+                  enabled = yes
+                  destination = localhost:2003
+                  username = my_username
+                  password = my_password
+          - name: 'Detailed Configuration for a remote, secure host'
+            folding:
+              enabled: false
+            description: 'Add `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.'
+            config: |
+              [graphite:https:netdata]
+                  enabled = yes
+                  username = my_username
+                  password = my_password
+                  destination = 10.10.1.114:2003
+                  # data source = average
+                  # prefix = netdata
+                  # hostname = my_hostname
+                  # update every = 10
+                  # buffer on failures = 10
+                  # timeout ms = 20000
+                  # send names instead of ids = yes
+                  # send charts matching = *
+                  # send hosts matching = localhost *
+- <<: *graphexport
+  id: 'export-blueflood'
+  meta:
+    <<: *meta
+    name: Blueflood
+    link: http://blueflood.io/
+    icon_filename: 'blueflood.png'
+    keywords:
+      - export
+      - Blueflood
+      - graphite
+- <<: *graphexport
+  id: 'export-influxdb'
+  meta:
+    <<: *meta
+    name: InfluxDB
+    link: https://www.influxdata.com/
+    icon_filename: 'influxdb.svg'
+    keywords:
+      - InfluxDB
+      - Influx
+      - export
+      - graphite
+- <<: *graphexport
+  id: 'export-kairosdb'
+  meta:
+    <<: *meta
+    name: KairosDB
+    link: https://kairosdb.github.io/
+    icon_filename: 'kairos.png'
+    keywords:
+      - KairosDB
+      - kairos
+      - export
+      - graphite