| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - &promexport |
| 4 | id: 'export-prometheus-remote' |
| 5 | meta: &meta |
| 6 | name: 'Prometheus Remote Write' |
| 7 | link: 'https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage' |
| 8 | categories: |
| 9 | - export |
| 10 | icon_filename: 'prometheus.svg' |
| 11 | keywords: |
| 12 | - exporter |
| 13 | - Prometheus |
| 14 | - remote write |
| 15 | - time series |
| 16 | overview: |
| 17 | exporter_description: | |
| 18 | Use the Prometheus remote write exporting connector to archive your Netdata metrics to the external storage provider of your choice for long-term storage and further analysis. |
| 19 | exporter_limitations: 'The remote write exporting connector does not support buffer on failures.' |
| 20 | setup: |
| 21 | prerequisites: |
| 22 | list: |
| 23 | - title: '' |
| 24 | description: | |
| 25 | - Netdata and the external storage provider of your choice, installed, configured and operational. |
| 26 | - `protobuf` and `snappy` libraries installed. |
| 27 | - Netdata reinstalled after the libraries. |
| 28 | configuration: |
| 29 | file: |
| 30 | name: 'exporting.conf' |
| 31 | options: |
| 32 | description: 'The following options can be defined for this exporter.' |
| 33 | folding: |
| 34 | title: 'Config options' |
| 35 | enabled: true |
| 36 | list: |
| 37 | - name: 'enabled' |
| 38 | default_value: 'no' |
| 39 | description: 'Enables or disables an exporting connector instance (yes|no).' |
| 40 | required: true |
| 41 | - name: 'destination' |
| 42 | default_value: 'no' |
| 43 | 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.' |
| 44 | required: true |
| 45 | detailed_description: | |
| 46 | The format of each item in this list, is: [PROTOCOL:]IP[:PORT]. |
| 47 | - PROTOCOL can be udp or tcp. tcp is the default and only supported by the current exporting engine. |
| 48 | - 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. |
| 49 | - PORT can be a number of a service name. If omitted, the default port for the exporting connector will be used. |
| 50 | |
| 51 | Example IPv4: |
| 52 | ```yaml |
| 53 | destination = 10.11.14.2:2003 10.11.14.3:4242 10.11.14.4:2003 |
| 54 | ``` |
| 55 | Example IPv6 and IPv4 together: |
| 56 | ```yaml |
| 57 | destination = [ffff:...:0001]:2003 10.11.12.1:2003 |
| 58 | ``` |
| 59 | When multiple servers are defined, Netdata will try the next one when the previous one fails. |
| 60 | - name: 'username' |
| 61 | default_value: 'my_username' |
| 62 | description: 'Username for HTTP authentication' |
| 63 | required: false |
| 64 | - name: 'password' |
| 65 | default_value: 'my_password' |
| 66 | description: 'Password for HTTP authentication' |
| 67 | required: false |
| 68 | - name: 'data source' |
| 69 | default_value: '' |
| 70 | description: 'Selects the kind of data that will be sent to the external database. (as collected|average|sum)' |
| 71 | required: false |
| 72 | - name: 'hostname' |
| 73 | default_value: '[global].hostname' |
| 74 | description: 'The hostname to be used for sending data to the external database server.' |
| 75 | required: false |
| 76 | - name: 'prefix' |
| 77 | default_value: 'netdata' |
| 78 | description: 'The prefix to add to all metrics.' |
| 79 | required: false |
| 80 | - name: 'update every' |
| 81 | default_value: '10' |
| 82 | description: | |
| 83 | Frequency of sending sending data to the external database, in seconds. |
| 84 | required: false |
| 85 | detailed_description: | |
| 86 | Netdata will add some randomness to this number, to prevent stressing the external server when many Netdata servers |
| 87 | send data to the same database. This randomness does not affect the quality of the data, only the time they are sent. |
| 88 | - name: 'buffer on failures' |
| 89 | default_value: '10' |
| 90 | description: | |
| 91 | The number of iterations (`update every` seconds) to buffer data, when the external database server is not available. |
| 92 | required: false |
| 93 | detailed_description: | |
| 94 | 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). |
| 95 | - name: 'timeout ms' |
| 96 | default_value: '20000' |
| 97 | description: 'The timeout in milliseconds to wait for the external database server to process the data.' |
| 98 | required: false |
| 99 | - name: 'send hosts matching' |
| 100 | default_value: 'localhost *' |
| 101 | description: | |
| 102 | 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). |
| 103 | required: false |
| 104 | detailed_description: | |
| 105 | Includes one or more space separated patterns, using * as wildcard (any number of times within each pattern). |
| 106 | The patterns are checked against the hostname (the localhost is always checked as localhost), allowing us to |
| 107 | filter which hosts will be sent to the external database when this Netdata is a central Netdata aggregating multiple hosts. |
| 108 | |
| 109 | A pattern starting with `!` gives a negative match. So to match all hosts named `*db*` except hosts containing `*child*`, |
| 110 | use `!*child* *db*` (so, the order is important: the first pattern matching the hostname will be used - positive or negative). |
| 111 | - name: 'send charts matching' |
| 112 | default_value: '*' |
| 113 | description: | |
| 114 | One or more space separated patterns (use * as wildcard) checked against both chart id and chart name. |
| 115 | required: false |
| 116 | detailed_description: | |
| 117 | A pattern starting with ! gives a negative match. So to match all charts named apps.* except charts ending in *reads, |
| 118 | use !*reads apps.* (so, the order is important: the first pattern matching the chart id or the chart name will be used, |
| 119 | positive or negative). There is also a URL parameter filter that can be used while querying allmetrics. The URL parameter |
| 120 | has a higher priority than the configuration option. |
| 121 | - name: 'send names instead of ids' |
| 122 | default_value: '' |
| 123 | description: 'Controls the metric names Netdata should send to the external database (yes|no).' |
| 124 | required: false |
| 125 | detailed_description: | |
| 126 | Netdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and names |
| 127 | are human friendly labels (also unique). Most charts and metrics have the same ID and name, but in several cases they are |
| 128 | different : disks with device-mapper, interrupts, QoS classes, statsd synthetic charts, etc. |
| 129 | - name: 'send configured labels' |
| 130 | default_value: '' |
| 131 | description: 'Controls if host labels defined in the `[host labels]` section in `netdata.conf` should be sent to the external database (yes|no).' |
| 132 | required: false |
| 133 | - name: 'send automatic labels' |
| 134 | default_value: '' |
| 135 | description: 'Controls if automatically created labels, like `_os_name` or `_architecture` should be sent to the external database (yes|no).' |
| 136 | required: false |
| 137 | examples: |
| 138 | folding: |
| 139 | enabled: true |
| 140 | title: '' |
| 141 | list: |
| 142 | - name: 'Example configuration' |
| 143 | folding: |
| 144 | enabled: false |
| 145 | description: 'Basic example configuration for Prometheus remote write.' |
| 146 | config: | |
| 147 | [prometheus_remote_write:my_instance] |
| 148 | enabled = yes |
| 149 | destination = 10.11.14.2:2003 |
| 150 | remote write URL path = /receive |
| 151 | - name: 'Example configuration with HTTPS and HTTP authentication' |
| 152 | folding: |
| 153 | enabled: false |
| 154 | description: 'Add `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.' |
| 155 | config: | |
| 156 | [prometheus_remote_write:https:my_instance] |
| 157 | enabled = yes |
| 158 | destination = 10.11.14.2:2003 |
| 159 | remote write URL path = /receive |
| 160 | username = my_username |
| 161 | password = my_password |
| 162 | - <<: *promexport |
| 163 | id: 'export-appoptics' |
| 164 | meta: |
| 165 | <<: *meta |
| 166 | name: AppOptics |
| 167 | link: https://www.solarwinds.com/appoptics |
| 168 | icon_filename: 'solarwinds.svg' |
| 169 | keywords: |
| 170 | - app optics |
| 171 | - AppOptics |
| 172 | - Solarwinds |
| 173 | - <<: *promexport |
| 174 | id: 'export-azure-data' |
| 175 | meta: |
| 176 | <<: *meta |
| 177 | name: Azure Data Explorer |
| 178 | link: https://azure.microsoft.com/en-us/pricing/details/data-explorer/ |
| 179 | icon_filename: 'azuredataex.jpg' |
| 180 | keywords: |
| 181 | - Azure Data Explorer |
| 182 | - Azure |
| 183 | - <<: *promexport |
| 184 | id: 'export-azure-event' |
| 185 | meta: |
| 186 | <<: *meta |
| 187 | name: Azure Event Hub |
| 188 | link: https://learn.microsoft.com/en-us/azure/event-hubs/event-hubs-about |
| 189 | icon_filename: 'azureeventhub.png' |
| 190 | keywords: |
| 191 | - Azure Event Hub |
| 192 | - Azure |
| 193 | - <<: *promexport |
| 194 | id: 'export-newrelic' |
| 195 | meta: |
| 196 | <<: *meta |
| 197 | name: New Relic |
| 198 | link: https://newrelic.com/ |
| 199 | icon_filename: 'newrelic.svg' |
| 200 | keywords: |
| 201 | - export |
| 202 | - NewRelic |
| 203 | - prometheus |
| 204 | - remote write |
| 205 | - <<: *promexport |
| 206 | id: 'export-quasar' |
| 207 | meta: |
| 208 | <<: *meta |
| 209 | name: QuasarDB |
| 210 | link: https://doc.quasar.ai/master/ |
| 211 | icon_filename: 'quasar.jpeg' |
| 212 | keywords: |
| 213 | - export |
| 214 | - quasar |
| 215 | - quasarDB |
| 216 | - prometheus |
| 217 | - remote write |
| 218 | - <<: *promexport |
| 219 | id: 'export-splunk' |
| 220 | meta: |
| 221 | <<: *meta |
| 222 | name: Splunk SignalFx |
| 223 | link: https://www.splunk.com/en_us/products/observability.html |
| 224 | icon_filename: 'splunk.svg' |
| 225 | keywords: |
| 226 | - export |
| 227 | - splunk |
| 228 | - signalfx |
| 229 | - prometheus |
| 230 | - remote write |
| 231 | - <<: *promexport |
| 232 | id: 'export-tikv' |
| 233 | meta: |
| 234 | <<: *meta |
| 235 | name: TiKV |
| 236 | link: https://tikv.org/ |
| 237 | icon_filename: 'tikv.png' |
| 238 | keywords: |
| 239 | - export |
| 240 | - TiKV |
| 241 | - prometheus |
| 242 | - remote write |
| 243 | - <<: *promexport |
| 244 | id: 'export-thanos' |
| 245 | meta: |
| 246 | <<: *meta |
| 247 | name: Thanos |
| 248 | link: https://thanos.io/ |
| 249 | icon_filename: 'thanos.png' |
| 250 | keywords: |
| 251 | - export |
| 252 | - thanos |
| 253 | - prometheus |
| 254 | - remote write |
| 255 | - <<: *promexport |
| 256 | id: 'export-victoria' |
| 257 | meta: |
| 258 | <<: *meta |
| 259 | name: VictoriaMetrics |
| 260 | link: https://victoriametrics.com/products/open-source/ |
| 261 | icon_filename: 'victoriametrics.png' |
| 262 | keywords: |
| 263 | - export |
| 264 | - victoriametrics |
| 265 | - prometheus |
| 266 | - remote write |
| 267 | - <<: *promexport |
| 268 | id: 'export-vmware' |
| 269 | meta: |
| 270 | <<: *meta |
| 271 | name: VMware Aria |
| 272 | link: https://www.vmware.com/products/aria-operations-for-applications.html |
| 273 | icon_filename: 'aria.png' |
| 274 | keywords: |
| 275 | - export |
| 276 | - VMware |
| 277 | - Aria |
| 278 | - Tanzu |
| 279 | - prometheus |
| 280 | - remote write |
| 281 | - <<: *promexport |
| 282 | id: 'export-chronix' |
| 283 | meta: |
| 284 | <<: *meta |
| 285 | name: Chronix |
| 286 | link: https://dbdb.io/db/chronix |
| 287 | icon_filename: 'chronix.png' |
| 288 | keywords: |
| 289 | - export |
| 290 | - chronix |
| 291 | - prometheus |
| 292 | - remote write |
| 293 | - <<: *promexport |
| 294 | id: 'export-cortex' |
| 295 | meta: |
| 296 | <<: *meta |
| 297 | name: Cortex |
| 298 | link: https://cortexmetrics.io/ |
| 299 | icon_filename: 'cortex.png' |
| 300 | keywords: |
| 301 | - export |
| 302 | - cortex |
| 303 | - prometheus |
| 304 | - remote write |
| 305 | - <<: *promexport |
| 306 | id: 'export-crate' |
| 307 | meta: |
| 308 | <<: *meta |
| 309 | name: CrateDB |
| 310 | link: https://crate.io/ |
| 311 | icon_filename: 'crate.svg' |
| 312 | keywords: |
| 313 | - export |
| 314 | - CrateDB |
| 315 | - prometheus |
| 316 | - remote write |
| 317 | - <<: *promexport |
| 318 | id: 'export-elastic' |
| 319 | meta: |
| 320 | <<: *meta |
| 321 | name: ElasticSearch |
| 322 | link: https://www.elastic.co/ |
| 323 | icon_filename: 'elasticsearch.svg' |
| 324 | keywords: |
| 325 | - export |
| 326 | - ElasticSearch |
| 327 | - prometheus |
| 328 | - remote write |
| 329 | - <<: *promexport |
| 330 | id: 'export-opensearch' |
| 331 | meta: |
| 332 | <<: *meta |
| 333 | name: OpeanSearch |
| 334 | link: https://opensearch.org/ |
| 335 | icon_filename: 'opensearch.svg' |
| 336 | keywords: |
| 337 | - export |
| 338 | - OpenSearch |
| 339 | - prometheus |
| 340 | - remote write |
| 341 | - <<: *promexport |
| 342 | id: 'export-gnocchi' |
| 343 | meta: |
| 344 | <<: *meta |
| 345 | name: Gnocchi |
| 346 | link: https://wiki.openstack.org/wiki/Gnocchi |
| 347 | icon_filename: 'gnocchi.svg' |
| 348 | keywords: |
| 349 | - export |
| 350 | - Gnocchi |
| 351 | - prometheus |
| 352 | - remote write |
| 353 | - <<: *promexport |
| 354 | id: 'export-bigquery' |
| 355 | meta: |
| 356 | <<: *meta |
| 357 | name: Google BigQuery |
| 358 | link: https://cloud.google.com/bigquery/ |
| 359 | icon_filename: 'bigquery.png' |
| 360 | keywords: |
| 361 | - export |
| 362 | - Google BigQuery |
| 363 | - prometheus |
| 364 | - remote write |
| 365 | - <<: *promexport |
| 366 | id: 'export-irondb' |
| 367 | meta: |
| 368 | <<: *meta |
| 369 | name: IRONdb |
| 370 | link: https://docs.circonus.com/irondb/ |
| 371 | icon_filename: 'irondb.png' |
| 372 | keywords: |
| 373 | - export |
| 374 | - IRONdb |
| 375 | - prometheus |
| 376 | - remote write |
| 377 | - <<: *promexport |
| 378 | id: 'export-kafka' |
| 379 | meta: |
| 380 | <<: *meta |
| 381 | name: Kafka |
| 382 | link: https://kafka.apache.org/ |
| 383 | icon_filename: 'kafka.svg' |
| 384 | keywords: |
| 385 | - export |
| 386 | - Kafka |
| 387 | - prometheus |
| 388 | - remote write |
| 389 | - <<: *promexport |
| 390 | id: 'export-m3db' |
| 391 | meta: |
| 392 | <<: *meta |
| 393 | name: M3DB |
| 394 | link: https://m3db.io/ |
| 395 | icon_filename: 'm3db.png' |
| 396 | keywords: |
| 397 | - export |
| 398 | - M3DB |
| 399 | - prometheus |
| 400 | - remote write |
| 401 | - <<: *promexport |
| 402 | id: 'export-metricfire' |
| 403 | meta: |
| 404 | <<: *meta |
| 405 | name: MetricFire |
| 406 | link: https://www.metricfire.com/ |
| 407 | icon_filename: 'metricfire.png' |
| 408 | keywords: |
| 409 | - export |
| 410 | - MetricFire |
| 411 | - prometheus |
| 412 | - remote write |
| 413 | - <<: *promexport |
| 414 | id: 'export-pgsql' |
| 415 | meta: |
| 416 | <<: *meta |
| 417 | name: PostgreSQL |
| 418 | link: https://www.postgresql.org/ |
| 419 | icon_filename: 'postgres.svg' |
| 420 | keywords: |
| 421 | - export |
| 422 | - PostgreSQL |
| 423 | - prometheus |
| 424 | - remote write |
| 425 | - <<: *promexport |
| 426 | id: 'export-wavefront' |
| 427 | meta: |
| 428 | <<: *meta |
| 429 | name: Wavefront |
| 430 | link: https://docs.wavefront.com/wavefront_data_ingestion.html |
| 431 | icon_filename: 'wavefront.png' |
| 432 | keywords: |
| 433 | - export |
| 434 | - Wavefront |
| 435 | - prometheus |
| 436 | - remote write |
| 437 | - <<: *promexport |
| 438 | id: 'export-timescaledb' |
| 439 | meta: |
| 440 | <<: *meta |
| 441 | name: TimescaleDB |
| 442 | link: https://www.timescale.com/ |
| 443 | icon_filename: 'timescale.png' |
| 444 | keywords: |
| 445 | - export |
| 446 | - TimescaleDB |
| 447 | - prometheus |
| 448 | - remote write |
| 449 | - <<: *promexport |
| 450 | id: 'export-greptimedb' |
| 451 | meta: |
| 452 | <<: *meta |
| 453 | name: GreptimeDB |
| 454 | link: https://greptime.com/product/db |
| 455 | icon_filename: 'greptimedb.svg' |
| 456 | keywords: |
| 457 | - export |
| 458 | - GreptimeDB |
| 459 | - prometheus |
| 460 | - remote write |