Prometheus Remote Write
Configuration Options
Required Options
address(required)
The address to accept connections on. The address must include a port.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["0.0.0.0:9090"] |
type(required)
The component type. This is a required field for all components and tells Vector which component to use.
| Type | Syntax | Default | Example |
|---|---|---|---|
| string | literal | ["prometheus_remote_write"] |
Advanced Options
acknowledgements(optional)
Controls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
| Type | Syntax | Default | Example |
|---|---|---|---|
| bool |
tls(optional)
Configures the TLS options for incoming connections.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
auth(optional)
Options for HTTP Basic Authentication.
| Type | Syntax | Default | Example |
|---|---|---|---|
| hash | literal | [] |
How it Works
Metric type interpretation
The remote_write protocol used by this source transmits only the metric tags, timestamp, and numerical value. No explicit information about the original type of the metric (i.e. counter, histogram, etc) is included. As such, this source makes a guess as to what the original metric type was.
For metrics named with a suffix of _total, this source
emits the value as a counter metric. All other metrics
are emitted as gauges.
State
This component is stateless, meaning its behavior is consistent across each input.
Transport Layer Security (TLS)
Vector uses OpenSSL for TLS protocols. You can
adjust TLS behavior via the tls.* options.
Context
By default, the prometheus_remote_write source augments events with helpful
context keys.