GCP PubSub Sink

The Vector gcp_pubsub sink batches log events to Google Cloud Platform's Pubsub service via the REST Interface.

Configuration

Common
Advanced

vector.toml

[sinks.my_sink_id]
  type = "gcp_pubsub" # required
  inputs = ["my-source-or-transform-id"] # required
  credentials_path = "/path/to/credentials.json" # optional, no default
  healthcheck = true # optional, default

10 items

commonrequired

stringoptional
api_key
A Google Cloud API key used to authenticate access the pubsub project and topic. Either this or credentials_path must be set. See GCP Authentication for more info.
- No default
- View examples
tableoptional
batch
Configures the sink batching behavior.
- uint (bytes)commonoptional
  max_bytes
  The maximum size of a batch, in bytes, before it is flushed.
  - Default: 10485760 (bytes)
- uint (events)commonoptional
  max_events
  The maximum size of a batch, in events, before it is flushed. See Buffers & Batches for more info.
  - Default: 1000 (events)
- uint (seconds)commonoptional
  timeout_secs
  The maximum age of a batch before it is flushed. See Buffers & Batches for more info.
  - Default: 1 (seconds)
tableoptional
buffer
Configures the sink specific buffer behavior.
- uint (events)commonoptional
  max_events
  The maximum number of events allowed in the buffer. See Buffers & Batches for more info.
  - Only relevant when: type = "memory"
  - Default: 500 (events)
- uint (bytes)required*
  max_size
  The maximum size of the buffer on the disk.
  - Only required when: type = "disk"
  - No default
  - View examples
- stringenumcommonoptional
  type
  The buffer's type and storage mechanism.
  - Default: "memory"
  - Enum, must be one of: "memory" "disk"
  - View examples
- stringenumoptional
  when_full
  The behavior when the buffer becomes full.
  - Default: "block"
  - Enum, must be one of: "block" "drop_newest"
  - View examples
stringcommonoptional
credentials_path
The filename for a Google Cloud service account credentials JSON file used to authenticate access to the pubsub project and topic. If this is unset, Vector checks the GOOGLE_APPLICATION_CREDENTIALS environment variable for a filename.
If no filename is named, Vector will attempt to fetch an instance service account for the compute instance the program is running on. If Vector is not running on a GCE instance, you must define a credentials file as above. See GCP Authentication for more info.
- No default
- View examples
tableoptional
encoding
Configures the encoding specific sink behavior.
- [string]optional
  except_fields
  Prevent the sink from encoding the specified labels.
  - No default
  - View examples
- [string]optional
  only_fields
  Limit the sink to only encoding the specified labels.
  - No default
  - View examples
- stringenumoptional
  timestamp_format
  How to format event timestamps.
  - Default: "rfc3339"
  - Enum, must be one of: "rfc3339" "unix"
  - View examples
boolcommonoptional
healthcheck
Enables/disables the sink healthcheck upon start. See Health Checks for more info.
- Default: true
- View examples
stringrequired
project
The project name to which to publish logs.
- No default
- View examples
tableoptional
request
Configures the sink request behavior.
- uint (requests)commonoptional
  in_flight_limit
  The maximum number of in-flight requests allowed at any given time. See Rate Limits for more info.
  - Default: 5 (requests)
- uint (seconds)commonoptional
  rate_limit_duration_secs
  The time window, in seconds, used for the rate_limit_num option. See Rate Limits for more info.
  - Default: 1 (seconds)
- uintcommonoptional
  rate_limit_num
  The maximum number of requests allowed within the rate_limit_duration_secs time window. See Rate Limits for more info.
  - Default: 100
- uintoptional
  retry_attempts
  The maximum number of retries to make for failed requests. The default, for all intents and purposes, represents an infinite number of retries. See Retry Policy for more info.
  - Default: 18446744073709552000
- uint (seconds)optional
  retry_initial_backoff_secs
  The amount of time to wait before attempting the first retry for a failed request. Once, the first retry has failed the fibonacci sequence will be used to select future backoffs.
  - Default: 1 (seconds)
- uint (seconds)optional
  retry_max_duration_secs
  The maximum amount of time, in seconds, to wait between retries.
  - Default: 10 (seconds)
- uint (seconds)commonoptional
  timeout_secs
  The maximum time a request can take before being aborted. It is highly recommended that you do not lower value below the service's internal timeout, as this could create orphaned requests, pile on retries, and result in duplicate data downstream. See Buffers & Batches for more info.
  - Default: 60 (seconds)
tableoptional
tls
Configures the TLS options for connections from this sink.
- 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 connection, 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.
  - No default
  - View examples
- stringcommonoptional
  key_file
  Absolute path to a private key file used to identify this connection, in DER or PEM format (PKCS#8), or an inline private key in PEM format. If this is set, crt_file must also be set.
  - No default
  - View examples
- stringoptional
  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 (the default), Vector will validate the TLS certificate of the remote host.
  - WARNING: Setting this to `false` means the certificate will be loaded and checked for validity, but the handshake will not attempt to verify the certificate. Do NOT set this to `false` unless you understand the risks of not verifying the remote certificate.
  - Default: true
  - View examples
- booloptional
  verify_hostname
  If true (the default), Vector will validate the configured remote host name against the remote host's TLS certificate. Do NOT set this to false unless you understand the risks of not verifying the remote hostname.
  - Default: true
  - View examples
stringrequired
topic
The topic within the project to which to publish logs.
- No default
- View examples

Env Vars

stringcommonoptional
GOOGLE_APPLICATION_CREDENTIALS
The filename for a Google Cloud service account credentials JSON file used to authenticate access to the pubsub project and topic. See GCP Authentication for more info.
- No default
- View examples

How It Works

Buffers & Batches

The gcp_pubsub sink buffers & batches data as shown in the diagram above. You'll notice that Vector treats these concepts differently, instead of treating them as global concepts, Vector treats them as sink specific concepts. This isolates sinks, ensuring services disruptions are contained and delivery guarantees are honored.

Batches are flushed when 1 of 2 conditions are met:

The batch age meets or exceeds the configured timeout_secs.
The batch size meets or exceeds the configured max_events.

Buffers are controlled via the buffer.* options.

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.

GCP Authentication

GCP offers a variety of authentication methods and Vector is concerned with the server to server methods and will find credentials in the following order:

If the credentials_path option is set.
If the api_key option is set.
If the GOOGLE_APPLICATION_CREDENTIALS envrionment variable is set.
Finally, Vector will check for an instance service account.

If credentials are not found the healtcheck will fail and an error will be logged.

Health Checks

Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. If the health check fails an error will be logged and Vector will proceed to start.

Require Health Checks

If you'd like to exit immediately upon a health check failure, you can pass the --require-healthy flag:

vector --config /etc/vector/vector.toml --require-healthy

Disable Health Checks

If you'd like to disable health checks for this sink you can set the healthcheck option to false.

Rate Limits

Vector offers a few levers to control the rate and volume of requests to the downstream service. Start with the rate_limit_duration_secs and rate_limit_num options to ensure Vector does not exceed the specified number of requests in the specified window. You can further control the pace at which this window is saturated with the in_flight_limit option, which will guarantee no more than the specified number of requests are in-flight at any given time.

Please note, Vector's defaults are carefully chosen and it should be rare that you need to adjust these. If you found a good reason to do so please share it with the Vector team by opening an issue.

Retry Policy

Vector will retry failed requests (status == 429, >= 500, and != 501). Other responses will not be retried. You can control the number of retry attempts and backoff rate with the retry_attempts and retry_backoff_secs options.

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.

#Configuration

#api_key

#batch

#max_bytes

#max_events

#timeout_secs

#buffer

#max_events

#max_size

#type

#when_full

#credentials_path

#encoding

#except_fields

#only_fields

#timestamp_format

#healthcheck

#project

#request

#in_flight_limit

#rate_limit_duration_secs

#rate_limit_num

#retry_attempts

#retry_initial_backoff_secs

#retry_max_duration_secs

#timeout_secs

#tls

#ca_file

#crt_file

#key_file

#key_pass

#verify_certificate

#verify_hostname

#topic

#Env Vars

#GOOGLE_APPLICATION_CREDENTIALS

#How It Works

#Buffers & Batches

#Environment Variables

#GCP Authentication

#Health Checks

#Require Health Checks

#Disable Health Checks

#Rate Limits

#Retry Policy

#TLS

Configuration

api_key

batch

max_bytes

max_events

timeout_secs

buffer

max_events

max_size

type

when_full

credentials_path

encoding

except_fields

only_fields

timestamp_format

healthcheck

project

request

in_flight_limit

rate_limit_duration_secs

rate_limit_num

retry_attempts

retry_initial_backoff_secs

retry_max_duration_secs

timeout_secs

tls

ca_file

crt_file

key_file

key_pass

verify_certificate

verify_hostname

topic