130 lines
4.5 KiB
Markdown
130 lines
4.5 KiB
Markdown
|
# InfluxDB v1.x Output Plugin
|
||
|
|
||
|
This plugin writes metrics to a [InfluxDB v1.x][influxdb_v1] instance via
|
||
|
HTTP or UDP protocol.
|
||
|
|
||
|
⭐ Telegraf v0.1.1
|
||
|
🏷️ datastore
|
||
|
💻 all
|
||
|
|
||
|
[influxdb_v1]: https://docs.influxdata.com/influxdb/v1
|
||
|
|
||
|
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
||
|
|
||
|
In addition to the plugin-specific configuration settings, plugins support
|
||
|
additional global and plugin configuration settings. These settings are used to
|
||
|
modify metrics, tags, and field or create aliases and configure ordering, etc.
|
||
|
See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
|
||
|
|
||
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
||
|
|
||
|
## Secret-store support
|
||
|
|
||
|
This plugin supports secrets from secret-stores for the `username` and
|
||
|
`password` option.
|
||
|
See the [secret-store documentation][SECRETSTORE] for more details on how
|
||
|
to use them.
|
||
|
|
||
|
[SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets
|
||
|
|
||
|
## Configuration
|
||
|
|
||
|
```toml @sample.conf
|
||
|
# Configuration for sending metrics to InfluxDB
|
||
|
[[outputs.influxdb]]
|
||
|
## The full HTTP or UDP URL for your InfluxDB instance.
|
||
|
##
|
||
|
## Multiple URLs can be specified for a single cluster, only ONE of the
|
||
|
## urls will be written to each interval.
|
||
|
# urls = ["unix:///var/run/influxdb.sock"]
|
||
|
# urls = ["udp://127.0.0.1:8089"]
|
||
|
# urls = ["http://127.0.0.1:8086"]
|
||
|
|
||
|
## Local address to bind when connecting to the server
|
||
|
## If empty or not set, the local address is automatically chosen.
|
||
|
# local_address = ""
|
||
|
|
||
|
## The target database for metrics; will be created as needed.
|
||
|
## For UDP url endpoint database needs to be configured on server side.
|
||
|
# database = "telegraf"
|
||
|
|
||
|
## The value of this tag will be used to determine the database. If this
|
||
|
## tag is not set the 'database' option is used as the default.
|
||
|
# database_tag = ""
|
||
|
|
||
|
## If true, the 'database_tag' will not be included in the written metric.
|
||
|
# exclude_database_tag = false
|
||
|
|
||
|
## If true, no CREATE DATABASE queries will be sent. Set to true when using
|
||
|
## Telegraf with a user without permissions to create databases or when the
|
||
|
## database already exists.
|
||
|
# skip_database_creation = false
|
||
|
|
||
|
## Name of existing retention policy to write to. Empty string writes to
|
||
|
## the default retention policy. Only takes effect when using HTTP.
|
||
|
# retention_policy = ""
|
||
|
|
||
|
## The value of this tag will be used to determine the retention policy. If this
|
||
|
## tag is not set the 'retention_policy' option is used as the default.
|
||
|
# retention_policy_tag = ""
|
||
|
|
||
|
## If true, the 'retention_policy_tag' will not be included in the written metric.
|
||
|
# exclude_retention_policy_tag = false
|
||
|
|
||
|
## Write consistency (clusters only), can be: "any", "one", "quorum", "all".
|
||
|
## Only takes effect when using HTTP.
|
||
|
# write_consistency = "any"
|
||
|
|
||
|
## Timeout for HTTP messages.
|
||
|
# timeout = "5s"
|
||
|
|
||
|
## HTTP Basic Auth
|
||
|
# username = "telegraf"
|
||
|
# password = "metricsmetricsmetricsmetrics"
|
||
|
|
||
|
## HTTP User-Agent
|
||
|
# user_agent = "telegraf"
|
||
|
|
||
|
## UDP payload size is the maximum packet size to send.
|
||
|
# udp_payload = "512B"
|
||
|
|
||
|
## Optional TLS Config for use on HTTP connections.
|
||
|
# tls_ca = "/etc/telegraf/ca.pem"
|
||
|
# tls_cert = "/etc/telegraf/cert.pem"
|
||
|
# tls_key = "/etc/telegraf/key.pem"
|
||
|
## Use TLS but skip chain & host verification
|
||
|
# insecure_skip_verify = false
|
||
|
|
||
|
## HTTP Proxy override, if unset values the standard proxy environment
|
||
|
## variables are consulted to determine which proxy, if any, should be used.
|
||
|
# http_proxy = "http://corporate.proxy:3128"
|
||
|
|
||
|
## Additional HTTP headers
|
||
|
# http_headers = {"X-Special-Header" = "Special-Value"}
|
||
|
|
||
|
## HTTP Content-Encoding for write request body, can be set to "gzip" to
|
||
|
## compress body or "identity" to apply no encoding.
|
||
|
# content_encoding = "gzip"
|
||
|
|
||
|
## When true, Telegraf will output unsigned integers as unsigned values,
|
||
|
## i.e.: "42u". You will need a version of InfluxDB supporting unsigned
|
||
|
## integer values. Enabling this option will result in field type errors if
|
||
|
## existing data has been written.
|
||
|
# influx_uint_support = false
|
||
|
|
||
|
## When true, Telegraf will omit the timestamp on data to allow InfluxDB
|
||
|
## to set the timestamp of the data during ingestion. This is generally NOT
|
||
|
## what you want as it can lead to data points captured at different times
|
||
|
## getting omitted due to similar data.
|
||
|
# influx_omit_timestamp = false
|
||
|
```
|
||
|
|
||
|
To send every metrics into multiple influxdb,
|
||
|
define additional `[[outputs.influxdb]]` section with new `urls`.
|
||
|
|
||
|
## Metrics
|
||
|
|
||
|
Reference the [influx serializer][] for details about metric production.
|
||
|
|
||
|
[influx serializer]: /plugins/serializers/influx/README.md#Metrics
|