Socket

Collect logs using the socket client

status: stable role: aggregator role: sidecar delivery: best effort egress: stream state: stateless output: log

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "socket",
      "address": "0.0.0.0:9000",
      "max_length": 102400,
      "mode": "tcp",
      "path": "/path/to/socket"
    }
  }
}
[sources.my_source_id]
type = "socket"
address = "0.0.0.0:9000"
max_length = 102_400
mode = "tcp"
path = "/path/to/socket"
---
sources:
  my_source_id:
    type: socket
    address: 0.0.0.0:9000
    max_length: 102400
    mode: tcp
    path: /path/to/socket
{
  "sources": {
    "my_source_id": {
      "type": "socket",
      "address": "0.0.0.0:9000",
      "host_key": "host",
      "max_length": 102400,
      "mode": "tcp",
      "path": "/path/to/socket",
      "shutdown_timeout_secs": 30
    }
  }
}
[sources.my_source_id]
type = "socket"
address = "0.0.0.0:9000"
host_key = "host"
max_length = 102_400
mode = "tcp"
path = "/path/to/socket"
shutdown_timeout_secs = 30
---
sources:
  my_source_id:
    type: socket
    address: 0.0.0.0:9000
    host_key: host
    max_length: 102400
    mode: tcp
    path: /path/to/socket
    keepalive: null
    tls: null
    shutdown_timeout_secs: 30

address

required string
The 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.

host_key

optional string
The key name added to each event representing the current host. This can also be globally set via the global host_key option.
default: host

keepalive

optional object
Configures the TCP keepalive behavior for the connection to the source.

keepalive.time_secs

optional uint
The time a connection needs to be idle before sending TCP keepalive probes.

max_length

common optional uint
The maximum bytes size of incoming messages before they are discarded.
default: 102400 (bytes)

mode

required string enum
The type of socket to use.
Enum options string literal
OptionDescription
tcpTCP socket.
udpUDP socket.
unix_datagramUnix domain datagram socket.
unix_streamUnix domain stream socket.

path

required string
The unix socket path. This should be an absolute path.

shutdown_timeout_secs

optional uint
The timeout before a connection is forcefully closed during shutdown.
default: 30 (seconds)

tls

optional object
Configures the TLS options for incoming connections.

tls.ca_file

optional string literal
Absolute 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 literal
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 if enabled is set to true.

tls.enabled

optional bool
Require TLS for incoming connections. If this is set, an identity certificate is also required.
default: false

tls.key_file

optional string literal
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.

tls.key_pass

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

tls.verify_certificate

optional bool
If 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

Output

Logs

line

A single socket event.

Telemetry

Metrics

link

connection_errors_total

counter
The total number of connection errors for this Vector instance.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

connection_established_total

counter
The total number of times a connection has been established.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

connection_failed_total

counter
The total number of times a connection has failed.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

connection_send_ack_errors_total

counter
The total number of protocol acknowledgement errors for this Vector instance for source protocols that support acknowledgements.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

connection_send_errors_total

counter
The total number of errors sending data via the connection.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

connection_shutdown_total

counter
The total number of times the connection has been shut down.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
host required
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 event originates.
peer_path optional
The pathname from which the event originates.
pid required
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

Examples

Socket line

Given this event...
2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1
...and this configuration...
[sources.my_source_id]
type = "socket"
---
sources:
  my_source_id:
    type: socket
{
  "sources": {
    "my_source_id": {
      "type": "socket"
    }
  }
}
...this Vector event is produced:
{
  "log": {
    "host": "my-host.local",
    "message": "2019-02-13T19:48:34+00:00 [info] Started GET \"/\" for 127.0.0.1",
    "timestamp": "2020-10-10T17:07:36.452332Z"
  }
}

How it works

Context

By default, the socket source augments events with helpful context keys.

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.