Vector Source
The Vector vector
source
receives data from another upstream Vector instance using the Vector sink.
Requirements
Configuration
- Common
- Advanced
- vector.toml
- vector.yaml
- vector.json
[sources.my_source_id]type = "vector" # requiredaddress = "0.0.0.0:9000" # required
- requiredstring
address
The TCP address to listen for connections on, or `systemd#N to use the Nth socket passed by systemd socket activation. If an address is used it must include a port.
- View examples
- optionaltable
keepalive
Configures the TCP keepalive behavior for the connection to the source.
- optionaluint
time_secs
The time a connection needs to be idle before sending TCP keepalive probes.
- optionaluint
shutdown_timeout_secs
The timeout before a connection is forcefully closed during shutdown.
- Default:
30
(seconds)
- Default:
- optionaltable
tls
Configures the TLS options for incoming connections.
- optionalstring
ca_file
Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.
- View examples
- optionalstring
crt_file
Absolute 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 ifenabled
is set totrue
.- View examples
- optionalbool
enabled
Require TLS for incoming connections. If this is set, an identity certificate is also required.
- Default:
false
- View examples
- Default:
- optionalstring
key_file
Absolute 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.
- View examples
- optionalstring
key_pass
Pass phrase used to unlock the encrypted key file. This has no effect unless
key_file
is set.- View examples
- optionalbool
verify_certificate
If
true
, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. Iffalse
(the default), Vector will not request a certificate from the client.- Default:
false
- View examples
- Default:
Output
This component outputs log events with the following fields:
{"*" : null}
- required*
*
Vector transparently forwards data from another upstream Vector instance. The
vector
source will not modify or add fields.
Telemetry
This component provides the following metrics that can be retrieved through
the internal_metrics
source. See the
metrics section in the
monitoring page for more info.
- counter
protobuf_decode_errors_total
The total number of Protocol Buffers errors thrown during communication between Vector instances. This metric includes the following tags:
component_kind
- The Vector component kind.component_name
- The Vector component ID.component_type
- The Vector component type.instance
- The Vector instance identified by host and port.job
- The name of the job producing Vector metrics.
- counter
processed_events_total
The total number of events processed by this component. This metric includes the following tags:
component_kind
- The Vector component kind.component_name
- The Vector component ID.component_type
- The Vector component type.file
- The file that produced the errorinstance
- The Vector instance identified by host and port.job
- The name of the job producing Vector metrics.
- counter
processed_bytes_total
The total number of bytes processed by the component. This metric includes the following tags:
component_kind
- The Vector component kind.component_name
- The Vector component ID.component_type
- The Vector component type.instance
- The Vector instance identified by host and port.job
- The name of the job producing Vector metrics.
How It Works
Communication Protocol
Upstream Vector instances forward data to downstream Vector instances via the TCP protocol.
Context
By default, the vector
source will augment events with helpful
context keys as shown in the "Output" section.
Encoding
Data is encoded via Vector's event protobuf before it is sent over the wire.
Message Acknowledgement
Currently, Vector does not perform any application level message acknowledgement. While rare, this means the individual message could be lost.
Transport Layer Security (TLS)
Vector uses Openssl for TLS protocols. You can
adjust TLS behavior via the tls.*
options.