Vector Source

The Vector vector source ingests data through another upstream vector sink and outputs log and metric events.

Requirements

Configuration

vector.toml
[sources.my_source_id]
type = "vector" # required
address = "0.0.0.0:9000" # required
  • stringcommonrequired

    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.

    • No default
    • View examples
  • uint (seconds)optional

    shutdown_timeout_secs

    The timeout before a connection is forcefully closed during shutdown.

    • Default: 30 (seconds)
  • tableoptional

    tls

    Configures the TLS options for connections from this source.

    • stringoptional

      ca_file

      Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an inline CA certificate in PEM format.

      • No default
      • View examples
    • stringcommonoptional

      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 inline 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.

      • No default
      • View examples
    • boolcommonoptional

      enabled

      Require TLS for incoming connections. If this is set, an identity certificate is also required.

      • Default: false
      • View examples
    • stringcommonoptional

      key_file

      Absolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an inline private key in PEM format.

      • No default
      • View examples
    • stringcommonoptional

      key_pass

      Pass phrase used to unlock the encrypted key file. This has no effect unless key_file is set.

      • No default
      • View examples
    • booloptional

      verify_certificate

      If true, Vector will require a TLS certificate from the connecting host and terminate the connection if it is not valid. If false (the default), Vector will not request a certificate from the client.

      • WARNING: Setting this to `false` will cause OpenSSL to not request a certificate from the client
      • Default: false
      • View examples

How It Works

Encoding

Data is encoded via Vector's event protobuf before it is sent over the wire.

Environment Variables

Environment variables are supported through all of Vector's configuration. Simply add ${MY_ENV_VAR} in your Vector configuration file and the variable will be replaced before being evaluated.

You can learn more in the Environment Variables section.

Message Ack'ing

Currently, Vector does not perform any application level message acknowledgement. While rare, this means the individual message could be lost.

TCP Protocol

Upstream Vector instances forward data to downstream Vector instances via the TCP protocol.

TLS

Vector uses Openssl for TLS protocols for it's battle-tested and reliable security. You can enable and adjust TLS behavior via the tls.* options.