| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - &graphexport |
| 4 | id: 'export-graphite' |
| 5 | meta: &meta |
| 6 | name: 'Graphite' |
| 7 | link: 'https://graphite.readthedocs.io/en/latest/' |
| 8 | categories: |
| 9 | - export |
| 10 | icon_filename: 'graphite.png' |
| 11 | keywords: |
| 12 | - exporter |
| 13 | - graphite |
| 14 | - remote write |
| 15 | - time series |
| 16 | overview: &overview |
| 17 | exporter_description: | |
| 18 | Use the Graphite connector for the exporting engine to archive your Netdata metrics to Graphite providers for long-term storage, |
| 19 | further analysis, or correlation with data from other sources. |
| 20 | exporter_limitations: '' |
| 21 | setup: |
| 22 | prerequisites: |
| 23 | list: [] |
| 24 | configuration: |
| 25 | file: |
| 26 | name: 'exporting.conf' |
| 27 | options: |
| 28 | description: 'The following options can be defined for this exporter.' |
| 29 | folding: |
| 30 | title: 'Config options' |
| 31 | enabled: true |
| 32 | list: |
| 33 | - name: 'enabled' |
| 34 | default_value: 'no' |
| 35 | description: 'Enables or disables an exporting connector instance (yes|no).' |
| 36 | required: true |
| 37 | - name: 'destination' |
| 38 | default_value: 'no' |
| 39 | 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.' |
| 40 | required: true |
| 41 | detailed_description: | |
| 42 | The format of each item in this list, is: [PROTOCOL:]IP[:PORT]. |
| 43 | - PROTOCOL can be udp or tcp. tcp is the default and only supported by the current exporting engine. |
| 44 | - 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. |
| 45 | - PORT can be a number of a service name. If omitted, the default port for the exporting connector will be used. |
| 46 | |
| 47 | Example IPv4: |
| 48 | ```yaml |
| 49 | destination = 10.11.14.2:2003 10.11.14.3:4242 10.11.14.4:2003 |
| 50 | ``` |
| 51 | Example IPv6 and IPv4 together: |
| 52 | ```yaml |
| 53 | destination = [ffff:...:0001]:2003 10.11.12.1:2003 |
| 54 | ``` |
| 55 | When multiple servers are defined, Netdata will try the next one when the previous one fails. |
| 56 | - name: 'username' |
| 57 | default_value: 'my_username' |
| 58 | description: 'Username for HTTP authentication' |
| 59 | required: false |
| 60 | - name: 'password' |
| 61 | default_value: 'my_password' |
| 62 | description: 'Password for HTTP authentication' |
| 63 | required: false |
| 64 | - name: 'data source' |
| 65 | default_value: '' |
| 66 | description: 'Selects the kind of data that will be sent to the external database. (as collected|average|sum)' |
| 67 | required: false |
| 68 | - name: 'hostname' |
| 69 | default_value: '[global].hostname' |
| 70 | description: 'The hostname to be used for sending data to the external database server.' |
| 71 | required: false |
| 72 | - name: 'prefix' |
| 73 | default_value: 'netdata' |
| 74 | description: 'The prefix to add to all metrics.' |
| 75 | required: false |
| 76 | - name: 'update every' |
| 77 | default_value: '10' |
| 78 | description: | |
| 79 | Frequency of sending sending data to the external database, in seconds. |
| 80 | required: false |
| 81 | detailed_description: | |
| 82 | Netdata will add some randomness to this number, to prevent stressing the external server when many Netdata servers |
| 83 | send data to the same database. This randomness does not affect the quality of the data, only the time they are sent. |
| 84 | - name: 'buffer on failures' |
| 85 | default_value: '10' |
| 86 | description: | |
| 87 | The number of iterations (`update every` seconds) to buffer data, when the external database server is not available. |
| 88 | required: false |
| 89 | detailed_description: | |
| 90 | 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). |
| 91 | - name: 'timeout ms' |
| 92 | default_value: '20000' |
| 93 | description: 'The timeout in milliseconds to wait for the external database server to process the data.' |
| 94 | required: false |
| 95 | - name: 'send hosts matching' |
| 96 | default_value: 'localhost *' |
| 97 | description: | |
| 98 | Hosts filter. Determines which hosts will be sent to the external database. The syntax is [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#simple-patterns). |
| 99 | required: false |
| 100 | detailed_description: | |
| 101 | Includes one or more space separated patterns, using * as wildcard (any number of times within each pattern). |
| 102 | The patterns are checked against the hostname (the localhost is always checked as localhost), allowing us to |
| 103 | filter which hosts will be sent to the external database when this Netdata is a central Netdata aggregating multiple hosts. |
| 104 | |
| 105 | A pattern starting with `!` gives a negative match. So to match all hosts named `*db*` except hosts containing `*child*`, |
| 106 | use `!*child* *db*` (so, the order is important: the first pattern matching the hostname will be used - positive or negative). |
| 107 | - name: 'send charts matching' |
| 108 | default_value: '*' |
| 109 | description: | |
| 110 | One or more space separated patterns (use * as wildcard) checked against both chart id and chart name. |
| 111 | required: false |
| 112 | detailed_description: | |
| 113 | A pattern starting with ! gives a negative match. So to match all charts named apps.* except charts ending in *reads, |
| 114 | use !*reads apps.* (so, the order is important: the first pattern matching the chart id or the chart name will be used, |
| 115 | positive or negative). There is also a URL parameter filter that can be used while querying allmetrics. The URL parameter |
| 116 | has a higher priority than the configuration option. |
| 117 | - name: 'send names instead of ids' |
| 118 | default_value: '' |
| 119 | description: 'Controls the metric names Netdata should send to the external database (yes|no).' |
| 120 | required: false |
| 121 | detailed_description: | |
| 122 | Netdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and names |
| 123 | are human friendly labels (also unique). Most charts and metrics have the same ID and name, but in several cases they are |
| 124 | different : disks with device-mapper, interrupts, QoS classes, statsd synthetic charts, etc. |
| 125 | - name: 'send configured labels' |
| 126 | default_value: '' |
| 127 | description: 'Controls if host labels defined in the `[host labels]` section in `netdata.conf` should be sent to the external database (yes|no).' |
| 128 | required: false |
| 129 | - name: 'send automatic labels' |
| 130 | default_value: '' |
| 131 | description: 'Controls if automatically created labels, like `_os_name` or `_architecture` should be sent to the external database (yes|no).' |
| 132 | required: false |
| 133 | examples: |
| 134 | folding: |
| 135 | enabled: true |
| 136 | title: '' |
| 137 | list: |
| 138 | - name: 'Example configuration' |
| 139 | folding: |
| 140 | enabled: false |
| 141 | description: 'Basic configuration' |
| 142 | config: | |
| 143 | [graphite:netdata] |
| 144 | enabled = yes |
| 145 | destination = localhost:2003 |
| 146 | - name: 'Configuration with HTTPS and HTTP authentication' |
| 147 | folding: |
| 148 | enabled: false |
| 149 | description: 'Add `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.' |
| 150 | config: | |
| 151 | [graphite:netdata] |
| 152 | enabled = yes |
| 153 | destination = localhost:2003 |
| 154 | username = my_username |
| 155 | password = my_password |
| 156 | - name: 'Detailed Configuration for a remote, secure host' |
| 157 | folding: |
| 158 | enabled: false |
| 159 | description: 'Add `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.' |
| 160 | config: | |
| 161 | [graphite:https:netdata] |
| 162 | enabled = yes |
| 163 | username = my_username |
| 164 | password = my_password |
| 165 | destination = 10.10.1.114:2003 |
| 166 | # data source = average |
| 167 | # prefix = netdata |
| 168 | # hostname = my_hostname |
| 169 | # update every = 10 |
| 170 | # buffer on failures = 10 |
| 171 | # timeout ms = 20000 |
| 172 | # send names instead of ids = yes |
| 173 | # send charts matching = * |
| 174 | # send hosts matching = localhost * |
| 175 | - <<: *graphexport |
| 176 | id: 'export-blueflood' |
| 177 | overview: |
| 178 | <<: *overview |
| 179 | exporter_description: | |
| 180 | Export your Netdata metrics to Blueflood DB using the Graphite protocol, allowing you to archive your data for long-term storage, further analysis, or correlation with data from other sources. |
| 181 | meta: |
| 182 | <<: *meta |
| 183 | name: Blueflood |
| 184 | link: http://blueflood.io/ |
| 185 | icon_filename: 'blueflood.png' |
| 186 | keywords: |
| 187 | - export |
| 188 | - Blueflood |
| 189 | - graphite |
| 190 | - <<: *graphexport |
| 191 | id: 'export-kairosdb' |
| 192 | overview: |
| 193 | <<: *overview |
| 194 | exporter_description: | |
| 195 | Export your Netdata metrics to KairosDB using the Graphite protocol, allowing you to archive your data for long-term storage, further analysis, or correlation with data from other sources. |
| 196 | meta: |
| 197 | <<: *meta |
| 198 | name: KairosDB |
| 199 | link: https://kairosdb.github.io/ |
| 200 | icon_filename: 'kairos.png' |
| 201 | keywords: |
| 202 | - KairosDB |
| 203 | - kairos |
| 204 | - export |
| 205 | - graphite |