Vector
Collect observability data from another Vector instance
status: beta
role: aggregator
delivery: at-least-once
acknowledgements: yes
egress: stream
state: stateless
output: log
output: metrics
Receives data from another upstream Vector instance using the Vector sink.
Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "vector",
"acknowledgements": null,
"address": "0.0.0.0:9000",
"version": "2"
}
}
}
[sources.my_source_id]
type = "vector"
address = "0.0.0.0:9000"
version = "2"
---
sources:
my_source_id:
type: vector
acknowledgements: null
address: 0.0.0.0:9000
version: "2"
{
"sources": {
"my_source_id": {
"type": "vector",
"acknowledgements": null,
"address": "0.0.0.0:9000",
"shutdown_timeout_secs": 30,
"receive_buffer_bytes": 65536,
"keepalive": null,
"tls": null,
"version": "2"
}
}
}
[sources.my_source_id]
type = "vector"
address = "0.0.0.0:9000"
shutdown_timeout_secs = 30
receive_buffer_bytes = 65_536
version = "2"
---
sources:
my_source_id:
type: vector
acknowledgements: null
address: 0.0.0.0:9000
shutdown_timeout_secs: 30
receive_buffer_bytes: 65536
keepalive: null
tls: null
version: "2"
acknowledgements
common optional objectControls how acknowledgements are handled by this source. These settings override the global
acknowledgement
settings. This setting is deprecated in favor of enabling acknowledgements
in the destination sink.acknowledgements.enabled
optional boolControls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
default:
false
address
required string literalThe HTTP address to listen for connections on. It must include a port.
keepalive
optional objectConfigures the TCP keepalive behavior for the connection to the source.
keepalive.time_secs
optional uintThe time a connection needs to be idle before sending TCP keepalive probes.
receive_buffer_bytes
optional uintConfigures the receive buffer size using the
SO_RCVBUF
option on the socket.shutdown_timeout_secs
optional uintThe timeout before a connection is forcefully closed during shutdown.
default:
30
(seconds)tls
optional objectConfigures the TLS options for incoming connections.
tls.ca_file
optional string literalAbsolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.
tls.crt_file
optional string literalAbsolute path to a certificate file used to identify this server, in DER or PEM format (X.509) or PKCS#12, or an in-line certificate in PEM format. If this is set, and is not a PKCS#12 archive,
key_file
must also be set. This is required if enabled
is set to true
.tls.enabled
optional boolRequire TLS for incoming connections. If this is set, an identity certificate is also required.
default:
false
tls.key_file
optional string literalAbsolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an in-line private key in PEM format.
tls.key_pass
optional string literalPass phrase used to unlock the encrypted key file. This has no effect unless
key_file
is set.tls.verify_certificate
optional boolIf
true
, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. If false
(the default), Vector will not request a certificate from the client.default:
false
version
common optional string literal enumSource API version. Specifying this version ensures that Vector does not break backward compatibility.
Enum options
string
literal
Option | Description |
---|---|
1 | Vector source API version 1 |
2 | Vector source API version 2 |
default:
2
Outputs
<component_id>
Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.
Output Data
Metrics
counter
counterA single value that can be incremented or reset to a zero value but not decremented.
*
optional
Any tags present on the metric.
distribution
distributionA distribution represents a distribution of
sampled values. It is used with services
that support global histograms and summaries.
*
optional
Any tags present on the metric.
gauge
gaugeA gauge represents a point-in-time value
that can increase and decrease. Vector’s
internal gauge type represents changes to
that value. Gauges should be used to track
fluctuations in values, like current memory
or CPU usage.
*
optional
Any tags present on the metric.
Logs
Telemetry
Metrics
linkcomponent_discarded_events_total
counterThe number of events dropped by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
component_errors_total
counterThe total number of errors encountered by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
error_type
required
The type of the error
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
stage
required
The stage within the component at which the error occurred.
component_received_bytes_total
counterThe number of raw bytes accepted by this component from source origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_received_event_bytes_total
counterThe number of event bytes accepted by this component either from
tagged origins like file and uri, or cumulatively from other origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_received_events_total
counterThe number of events accepted by this component either from tagged
origins like file and uri, or cumulatively from other origins.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
component_sent_event_bytes_total
counterThe total number of event bytes emitted by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
component_sent_events_total
counterThe total number of events emitted by this component.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
events_in_total
counterThe number of events accepted by this component either from tagged
origins like file and uri, or cumulatively from other origins.
This metric is deprecated and will be removed in a future version.
Use
component_received_events_total
instead.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
container_name
optional
The name of the container from which the data originated.
file
optional
The file from which the data originated.
host
optional
The hostname of the system Vector is running on.
mode
optional
The connection mode used by the component.
peer_addr
optional
The IP from which the data originated.
peer_path
optional
The pathname from which the data originated.
pid
optional
The process ID of the Vector instance.
pod_name
optional
The name of the pod from which the data originated.
uri
optional
The sanitized URI from which the data originated.
events_out_total
counterThe total number of events emitted by this component.
This metric is deprecated and will be removed in a future version.
Use
component_sent_events_total
instead.component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
output
optional
The specific output of the component.
pid
optional
The process ID of the Vector instance.
protobuf_decode_errors_total
counterThe total number of Protocol Buffers errors thrown during communication between Vector instances.
component_id
required
The Vector component ID.
component_kind
required
The Vector component kind.
component_name
required
Deprecated, use
component_id
instead. The value is the same as component_id
.component_type
required
The Vector component type.
host
optional
The hostname of the system Vector is running on.
pid
optional
The process ID of the Vector instance.
How it works
Transport Layer Security (TLS)
Vector uses OpenSSL for TLS protocols. You can
adjust TLS behavior via the
tls.*
options.