InfluxDB metrics
Deliver metric event data to InfluxDB
Configuration
Example configurations
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
],
"bucket": "vector-bucket",
"consistency": "any",
"database": "vector-database",
"endpoint": "http://localhost:8086/",
"org": "my-org",
"password": "${INFLUXDB_PASSWORD}",
"retention_policy_name": "autogen",
"token": "${INFLUXDB_TOKEN}",
"default_namespace": "service",
"acknowledgements": null,
"encoding": null,
"healthcheck": null,
"username": "todd"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
bucket = "vector-bucket"
consistency = "any"
database = "vector-database"
endpoint = "http://localhost:8086/"
org = "my-org"
password = "${INFLUXDB_PASSWORD}"
retention_policy_name = "autogen"
token = "${INFLUXDB_TOKEN}"
default_namespace = "service"
username = "todd"
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
bucket: vector-bucket
consistency: any
database: vector-database
endpoint: http://localhost:8086/
org: my-org
password: ${INFLUXDB_PASSWORD}
retention_policy_name: autogen
token: ${INFLUXDB_TOKEN}
default_namespace: service
acknowledgements: null
encoding: null
healthcheck: null
username: todd
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
],
"bucket": "vector-bucket",
"consistency": "any",
"database": "vector-database",
"endpoint": "http://localhost:8086/",
"org": "my-org",
"password": "${INFLUXDB_PASSWORD}",
"retention_policy_name": "autogen",
"token": "${INFLUXDB_TOKEN}",
"default_namespace": "service",
"buffer": null,
"acknowledgements": null,
"batch": null,
"encoding": null,
"healthcheck": null,
"request": null,
"tls": null,
"username": "todd",
"tags": {
"region": "us-west-1"
}
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
bucket = "vector-bucket"
consistency = "any"
database = "vector-database"
endpoint = "http://localhost:8086/"
org = "my-org"
password = "${INFLUXDB_PASSWORD}"
retention_policy_name = "autogen"
token = "${INFLUXDB_TOKEN}"
default_namespace = "service"
username = "todd"
[sinks.my_sink_id.tags]
region = "us-west-1"
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
bucket: vector-bucket
consistency: any
database: vector-database
endpoint: http://localhost:8086/
org: my-org
password: ${INFLUXDB_PASSWORD}
retention_policy_name: autogen
token: ${INFLUXDB_TOKEN}
default_namespace: service
buffer: null
acknowledgements: null
batch: null
encoding: null
healthcheck: null
request: null
tls: null
username: todd
tags:
region: us-west-1
acknowledgements
common optional objectacknowledgement
settings.acknowledgements.enabled
optional boolfalse
batch
optional objectbatch.max_bytes
optional uintbatch.max_events
optional uintbatch.timeout_secs
optional float1
(seconds)bucket
required string literalbuffer
optional objectbuffer.max_events
optional uinttype = "memory"
500
(events)buffer.type
optional string literal enumOption | Description |
---|---|
disk | Stores the sink’s buffer on disk. This is less performant, but durable. Data will not be lost between restarts. Will also hold data in memory to enhance performance. WARNING: This may stall the sink if disk performance isn’t on par with the throughput. For comparison, AWS gp2 volumes are usually too slow for common cases. |
memory | Stores the sink’s buffer in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully. |
memory
buffer.when_full
optional string literal enumOption | Description |
---|---|
block | Applies back pressure when the buffer is full. This prevents data loss, but will cause data to pile up on the edge. |
drop_newest | Drops new data as it’s received. This data is lost. This should be used when performance is the highest priority. |
block
consistency
common optional string literaldatabase
required string literaldefault_namespace
common optional string literalencoding
common optional objectConfigures the encoding specific sink behavior.
Note: When data in encoding
is malformed, currently only a very generic error “data did not match any variant of untagged enum EncodingConfig” is reported. Follow this issue to track progress on improving these error messages.
encoding.except_fields
optional [string]encoding.only_fields
optional [string]encoding.timestamp_format
optional string literal enumOption | Description |
---|---|
rfc3339 | Formats as a RFC3339 string |
unix | Formats as a unix timestamp |
rfc3339
endpoint
required string literalinputs
required [string]A list of upstream source or transform
IDs. Wildcards (*
) are supported.
See configuration for more info.
org
required string literalpassword
common optional string literalrequest
optional objectrequest.adaptive_concurrency
optional objectrequest.adaptive_concurrency.decrease_ratio
optional float0.9
request.adaptive_concurrency.ewma_alpha
optional float0.7
request.adaptive_concurrency.rtt_deviation_scale
optional float2
request.concurrency
optional uintrequest.rate_limit_duration_secs
optional uintrate_limit_num
option.1
(seconds)request.rate_limit_num
optional uintrate_limit_duration_secs
time window.9.223372036854776e+18
request.retry_attempts
optional uint1.8446744073709552e+19
request.retry_initial_backoff_secs
optional uint1
(seconds)request.retry_max_duration_secs
optional uint3600
(seconds)request.timeout_secs
optional uint60
(seconds)retention_policy_name
common optional string literaltags
optional objecttls
optional objecttls.ca_file
optional string literaltls.crt_file
optional string literalkey_file
must also be set.tls.key_file
optional string literalcrt_file
must also be set.tls.key_pass
optional string literalkey_file
is set.tls.verify_certificate
optional booltrue
(the default), Vector will validate the TLS certificate of the remote host.true
tls.verify_hostname
optional booltrue
(the default), Vector will validate the configured remote host name against the remote host’s TLS certificate. Do NOT set this to false
unless you understand the risks of not verifying the remote hostname.true
token
required string literalusername
common optional string literalTelemetry
Metrics
linkbuffer_byte_size
gaugecomponent_id
instead. The value is the same as component_id
.buffer_discarded_events_total
countercomponent_id
instead. The value is the same as component_id
.buffer_events
gaugecomponent_id
instead. The value is the same as component_id
.buffer_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.buffer_received_events_total
countercomponent_id
instead. The value is the same as component_id
.buffer_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.buffer_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.component_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_events_count
histogramcomponent_id
instead. The value is the same as component_id
.component_received_events_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.events_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.utilization
gaugecomponent_id
instead. The value is the same as component_id
.Examples
Counter
Given this event...{
"metric": {
"counter": {
"value": 1.5
},
"kind": "incremental",
"name": "logins",
"tags": {
"host": "my-host.local"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
default_namespace = "service"
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
default_namespace: service
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
],
"default_namespace": "service"
}
}
}
service.logins,metric_type=counter,host=my-host.local value=1.5 1542182950000000011
Distribution
Given this event...{
"metric": {
"distribution": {
"samples": [
{
"rate": 1,
"value": 1
},
{
"rate": 2,
"value": 5
},
{
"rate": 3,
"value": 3
}
],
"statistic": "histogram"
},
"kind": "incremental",
"name": "sparse_stats",
"namespace": "app",
"tags": {
"host": "my-host.local"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
]
}
}
}
app.sparse_stats,metric_type=distribution,host=my-host.local avg=3.333333,count=6,max=5,median=3,min=1,quantile_0.95=5,sum=20 1542182950000000011
Gauge
Given this event...{
"metric": {
"gauge": {
"value": 1.5
},
"kind": "absolute",
"name": "memory_rss",
"namespace": "app",
"tags": {
"host": "my-host.local"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
default_namespace = "service"
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
default_namespace: service
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
],
"default_namespace": "service"
}
}
}
app.memory_rss,metric_type=gauge,host=my-host.local value=1.5 1542182950000000011
Histogram
Given this event...{
"metric": {
"histogram": {
"buckets": [
{
"count": 2,
"upper_limit": 1
},
{
"count": 5,
"upper_limit": 2.1
},
{
"count": 10,
"upper_limit": 3
}
],
"count": 17,
"sum": 46.2
},
"kind": "absolute",
"name": "requests",
"tags": {
"host": "my-host.local"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
]
}
}
}
requests,metric_type=histogram,host=my-host.local bucket_1=2i,bucket_2.1=5i,bucket_3=10i,count=17i,sum=46.2 1542182950000000011
Set
Given this event...{
"metric": {
"kind": "incremental",
"name": "users",
"set": {
"values": [
"first",
"another",
"last"
]
},
"tags": {
"host": "my-host.local"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
]
}
}
}
users,metric_type=set,host=my-host.local value=3 154218295000000001
Summary
Given this event...{
"metric": {
"kind": "absolute",
"name": "requests",
"summary": {
"count": 6,
"quantiles": [
{
"upper_limit": 0.01,
"value": 1.5
},
{
"upper_limit": 0.5,
"value": 2
},
{
"upper_limit": 0.99,
"value": 3
}
],
"sum": 12.1
},
"tags": {
"host": "my-host.local"
}
}
}
[sinks.my_sink_id]
type = "influxdb_metrics"
inputs = [ "my-source-or-transform-id" ]
---
sinks:
my_sink_id:
type: influxdb_metrics
inputs:
- my-source-or-transform-id
{
"sinks": {
"my_sink_id": {
"type": "influxdb_metrics",
"inputs": [
"my-source-or-transform-id"
]
}
}
}
requests,metric_type=summary,host=my-host.local count=6i,quantile_0.01=1.5,quantile_0.5=2,quantile_0.99=3,sum=12.1 1542182950000000011
How it works
Buffers and batches
This component buffers & batches data as shown in the diagram above. You’ll notice that Vector treats these concepts differently, instead of treating them as global concepts, Vector treats them as sink specific concepts. This isolates sinks, ensuring services disruptions are contained and delivery guarantees are honored.
Batches are flushed when 1 of 2 conditions are met:
- The batch age meets or exceeds the configured
timeout_secs
. - The batch size meets or exceeds the configured
max_bytes
ormax_events
.
Buffers are controlled via the buffer.*
options.
Health checks
Require health checks
If you’d like to exit immediately upon a health check failure, you can pass the
--require-healthy
flag:
vector --config /etc/vector/vector.toml --require-healthy
Disable health checks
healthcheck
option to
false
.Partitioning
Vector supports dynamic configuration values through a simple template syntax. If an option supports templating, it will be noted with a badge and you can use event fields to create dynamic values. For example:
[sinks.my-sink]
dynamic_option = "application={{ application_id }}"
In the above example, the application_id
for each event will be
used to partition outgoing data.
Rate limits & adapative concurrency
Adaptive Request Concurrency (ARC)
Adaptive Request Concurrency is a feature of Vector that does away with static concurrency limits and automatically optimizes HTTP concurrency based on downstream service responses. The underlying mechanism is a feedback loop inspired by TCP congestion control algorithms. Checkout the announcement blog post,
We highly recommend enabling this feature as it improves performance and reliability of Vector and the systems it communicates with. As such, we have made it the default, and no further configuration is required.
Static concurrency
If Adaptive Request Concurrency is not for you, you can manually set static concurrency
limits by specifying an integer for request.concurrency
:
[sinks.my-sink]
request.concurrency = 10
Rate limits
In addition to limiting request concurrency, you can also limit the overall request
throughput via the request.rate_limit_duration_secs
and request.rate_limit_num
options.
[sinks.my-sink]
request.rate_limit_duration_secs = 1
request.rate_limit_num = 10
These will apply to both adaptive
and fixed request.concurrency
values.