2022-02-04 18:12:24 +01:00
## `influxdb` sink
2022-02-07 16:51:46 +01:00
The `influxdb` sink uses the official [InfluxDB golang client ](https://pkg.go.dev/github.com/influxdata/influxdb-client-go/v2 ) to write the metrics to an InfluxDB database in a **blocking** fashion. It provides only support for V2 write endpoints (InfluxDB 1.8.0 or later).
2022-02-04 18:12:24 +01:00
### Configuration structure
```json
{
"< name > ": {
"type": "influxdb",
"meta_as_tags" : true,
"database" : "mymetrics",
"host": "dbhost.example.com",
"port": "4222",
"user": "exampleuser",
"password" : "examplepw",
"organization": "myorg",
"ssl": true,
2022-04-01 18:37:45 +02:00
"flush_delay" : "1s",
2023-10-09 16:57:26 +02:00
"batch_size" : 1000,
"use_gzip": true
2022-02-04 18:12:24 +01:00
}
}
```
- `type` : makes the sink an `influxdb` sink
- `meta_as_tags` : print all meta information as tags in the output (optional)
2023-10-09 10:12:14 +02:00
- `database` : All metrics are written to this bucket
2022-02-04 18:12:24 +01:00
- `host` : Hostname of the InfluxDB database server
2023-10-11 14:55:52 +02:00
- `port` : Port number (as string) of the InfluxDB database server
- `user` : Username for basic authentication
- `password` : Password for basic authentication
2022-02-04 18:12:24 +01:00
- `organization` : Organization in the InfluxDB
2022-03-11 13:43:03 +01:00
- `ssl` : Use SSL connection
2022-04-01 18:37:45 +02:00
- `flush_delay` : Group metrics coming in to a single batch
2023-10-09 10:12:14 +02:00
- `batch_size` : Maximal batch size. If `batch_size` is reached before the end of `flush_delay` , the metrics are sent without further delay
2022-03-11 13:43:03 +01:00
2023-09-29 10:36:42 +02:00
Influx client options:
2023-10-13 15:00:06 +02:00
- `http_request_timeout` : HTTP request timeout
- `retry_interval` : retry interval
- `max_retry_interval` : maximum delay between each retry attempt
2023-09-29 10:36:42 +02:00
- `retry_exponential_base` : base for the exponential retry delay
- `max_retries` : maximum count of retry attempts of failed writes
- `max_retry_time` : maximum total retry timeout
2023-10-09 16:57:26 +02:00
- `use_gzip` : Specify whether to use GZip compression in write requests