AMQP sink

Send events to AMQP 0.9.1 compatible brokers like RabbitMQ

Configuration

Example configurations

{
  "sinks": {
    "my_sink_id": {
      "type": "amqp",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "connection_string": "amqp://user:password@127.0.0.1:5672/%2f?timeout=10"
    }
  }
}

[sinks.my_sink_id]
type = "amqp"
inputs = [ "my-source-or-transform-id" ]
connection_string = "amqp://user:password@127.0.0.1:5672/%2f?timeout=10"

sinks:
  my_sink_id:
    type: amqp
    inputs:
      - my-source-or-transform-id
    connection_string: amqp://user:password@127.0.0.1:5672/%2f?timeout=10

{
  "sinks": {
    "my_sink_id": {
      "type": "amqp",
      "inputs": [
        "my-source-or-transform-id"
      ],
      "connection_string": "amqp://user:password@127.0.0.1:5672/%2f?timeout=10"
    }
  }
}

[sinks.my_sink_id]
type = "amqp"
inputs = [ "my-source-or-transform-id" ]
connection_string = "amqp://user:password@127.0.0.1:5672/%2f?timeout=10"

sinks:
  my_sink_id:
    type: amqp
    inputs:
      - my-source-or-transform-id
    connection_string: amqp://user:password@127.0.0.1:5672/%2f?timeout=10

acknowledgements

optional object

Controls how acknowledgements are handled for this sink.

See End-to-end Acknowledgements for more information on how event acknowledgement is handled.

acknowledgements.enabled

optional bool

Whether or not end-to-end acknowledgements are enabled.

When enabled for a sink, any source connected to that sink, where the source supports end-to-end acknowledgements as well, waits for events to be acknowledged by all connected sinks before acknowledging them at the source.

Enabling or disabling acknowledgements at the sink level takes precedence over any global acknowledgements configuration.

buffer

optional object

Configures the buffering behavior for this sink.

More information about the individual buffer types, and buffer behavior, can be found in the Buffering Model section.

buffer.max_events

optional uint

The maximum number of events allowed in the buffer.

Relevant when: type = "memory"

default: 500

buffer.max_size

required uint

The maximum size of the buffer on disk.

Must be at least ~256 megabytes (268435488 bytes).

Relevant when: type = "disk"

buffer.type

optional string literal enum

The type of buffer to use.

Enum options

Option Description

Option	Description
`disk`	Events are buffered on disk. This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes. Data is synchronized to disk every 500ms.
`memory`	Events are buffered in memory. This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes.

disk

Events are buffered on disk.

This is less performant, but more durable. Data that has been synchronized to disk will not be lost if Vector is restarted forcefully or crashes.

Data is synchronized to disk every 500ms.

memory

Events are buffered in memory.

This is more performant, but less durable. Data will be lost if Vector is restarted forcefully or crashes.

default: memory

buffer.when_full

optional string literal enum

Event handling behavior when a buffer is full.

Enum options

Option Description

Option	Description
`block`	Wait for free space in the buffer. This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge.
`drop_newest`	Drops the event instead of waiting for free space in buffer. The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.

block

Wait for free space in the buffer.

This applies backpressure up the topology, signalling that sources should slow down the acceptance/consumption of events. This means that while no data is lost, data will pile up at the edge.

drop_newest

Drops the event instead of waiting for free space in buffer.

The event will be intentionally dropped. This mode is typically used when performance is the highest priority, and it is preferable to temporarily lose events rather than cause a slowdown in the acceptance/consumption of events.

default: block

connection_string

required string literal

URI for the AMQP server.

The URI has the format of amqp://<user>:<password>@<host>:<port>/<vhost>?timeout=<seconds>.

The default vhost can be specified by using a value of %2f.

To connect over TLS, a scheme of amqps can be specified instead. For example, amqps://.... Additional TLS settings, such as client certificate verification, can be configured under the tls section.

Examples

"amqp://user:password@127.0.0.1:5672/%2f?timeout=10"

encoding

required object

Configures how events are encoded into raw bytes.

encoding.avro

required object

Apache Avro-specific encoder options.

Relevant when: codec = "avro"

encoding.avro.schema

required string literal

The Avro schema.

Examples

"{ \"type\": \"record\", \"name\": \"log\", \"fields\": [{ \"name\": \"message\", \"type\": \"string\" }] }"

encoding.codec

required string literal enum

The codec to use for encoding events.

Enum options

Option	Description
`avro`	Encodes an event as an Apache Avro message.
`csv`	Encodes an event as a CSV message. This codec must be configured with fields to encode.
`gelf`	Encodes an event as a GELF message. This codec is experimental for the following reason: The GELF specification is more strict than the actual Graylog receiver. Vector’s encoder currently adheres more strictly to the GELF spec, with the exception that some characters such as `@` are allowed in field names. Other GELF codecs such as Loki’s, use a Go SDK that is maintained by Graylog, and is much more relaxed than the GELF spec. Going forward, Vector will use that Go SDK as the reference implementation, which means the codec may continue to relax the enforcement of specification.
`json`	Encodes an event as JSON.
`logfmt`	Encodes an event as a logfmt message.
`native`	Encodes an event in the native Protocol Buffers format. This codec is experimental.
`native_json`	Encodes an event in the native JSON format. This codec is experimental.
`protobuf`	Encodes an event as a Protobuf message.
`raw_message`	No encoding. This encoding uses the `message` field of a log event. Be careful if you are modifying your log events (for example, by using a `remap` transform) and removing the message field while doing additional parsing on it, as this could lead to the encoding emitting empty strings for the given event.
`text`	Plain text encoding. This encoding uses the `message` field of a log event. For metrics, it uses an encoding that resembles the Prometheus export format. Be careful if you are modifying your log events (for example, by using a `remap` transform) and removing the message field while doing additional parsing on it, as this could lead to the encoding emitting empty strings for the given event.

Examples

"avro"

"csv"

"gelf"

"json"

"logfmt"

"native"

"native_json"

"protobuf"

"raw_message"

"text"

encoding.csv

required object

The CSV Serializer Options.

Relevant when: codec = "csv"

encoding.csv.capacity

optional uint

Set the capacity (in bytes) of the internal buffer used in the CSV writer. This defaults to a reasonable setting.

default: 8192

encoding.csv.delimiter

optional ascii_char

The field delimiter to use when writing CSV.

default: ,

encoding.csv.double_quote

optional bool

Enable double quote escapes.

This is enabled by default, but it may be disabled. When disabled, quotes in field data are escaped instead of doubled.

default: true

encoding.csv.escape

optional ascii_char

The escape character to use when writing CSV.

In some variants of CSV, quotes are escaped using a special escape character like \ (instead of escaping quotes by doubling them).

To use this, double_quotes needs to be disabled as well otherwise it is ignored.

default: "

encoding.csv.fields

required [string]

Configures the fields that will be encoded, as well as the order in which they appear in the output.

If a field is not present in the event, the output will be an empty string.

Values of type Array, Object, and Regex are not supported and the output will be an empty string.

encoding.csv.quote

optional ascii_char

The quote character to use when writing CSV.

default: "

encoding.csv.quote_style

optional string literal enum

The quoting style to use when writing CSV data.

Enum options

Option	Description
`always`	Always puts quotes around every field.
`necessary`	Puts quotes around fields only when necessary. They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field).
`never`	Never writes quotes, even if it produces invalid CSV data.
`non_numeric`	Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, then quotes are used even if they aren’t strictly necessary.

default: necessary

encoding.except_fields

optional [string]

List of fields that are excluded from the encoded event.

encoding.json

optional object

Options for the JsonSerializer.

Relevant when: codec = "json"

encoding.json.pretty

optional bool

Whether to use pretty JSON formatting.

default: false

encoding.metric_tag_values

optional string literal enum

Controls how metric tag values are encoded.

When set to single, only the last non-bare value of tags are displayed with the metric. When set to full, all metric tags are exposed as separate assignments.

Relevant when: codec = "json" or codec = "text"

Enum options

Option	Description
`full`	All tags are exposed as arrays of either string or null values.
`single`	Tag values are exposed as single strings, the same as they were before this config option. Tags with multiple values show the last assigned value, and null values are ignored.

default: single

encoding.only_fields

optional [string]

List of fields that are included in the encoded event.

encoding.protobuf

required object

Options for the Protobuf serializer.

Relevant when: codec = "protobuf"

encoding.protobuf.desc_file

required string literal

The path to the protobuf descriptor set file.

This file is the output of protoc -o <path> ...

Examples

"/etc/vector/protobuf_descriptor_set.desc"

encoding.protobuf.message_type

required string literal

The name of the message type to use for serializing.

Examples

"package.Message"

encoding.timestamp_format

optional string literal enum

Format used for timestamp fields.

Enum options

Option	Description
`rfc3339`	Represent the timestamp as a RFC 3339 timestamp.
`unix`	Represent the timestamp as a Unix timestamp.
`unix_float`	Represent the timestamp as a Unix timestamp in floating point.
`unix_ms`	Represent the timestamp as a Unix timestamp in milliseconds.
`unix_ns`	Represent the timestamp as a Unix timestamp in nanoseconds.
`unix_us`	Represent the timestamp as a Unix timestamp in microseconds

exchange

required string template

The exchange to publish messages to.

Note: This parameter supports Vector's template syntax, which enables you to use dynamic per-event values.

healthcheck

optional object

Healthcheck configuration.

healthcheck.enabled

optional bool

Whether or not to check the health of the sink when Vector starts up.

default: true

inputs

required [string]

A list of upstream source or transform IDs.

Wildcards (*) are supported.

See configuration for more info.

Array string literal

Examples

[
  "my-source-or-transform-id",
  "prefix-*"
]

properties

optional object

Configure the AMQP message properties.

AMQP message properties.

properties.content_encoding

optional string literal

Content-Encoding for the AMQP messages.

properties.content_type

optional string literal

Content-Type for the AMQP messages.

properties.expiration_ms

optional uint

Expiration for AMQP messages (in milliseconds)

routing_key

optional string template

Template used to generate a routing key which corresponds to a queue binding.

Note: This parameter supports Vector's template syntax, which enables you to use dynamic per-event values.

tls

optional object

TLS configuration.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protocols.

Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order that they are defined.

tls.ca_file

optional string literal

Absolute path to an additional CA certificate file.

The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.

Examples

"/path/to/certificate_authority.crt"

tls.crt_file

optional string literal

Absolute path to a certificate file used to identify this server.

The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string in PEM format.

If this is set, and is not a PKCS#12 archive, key_file must also be set.

Examples

"/path/to/host_certificate.crt"

tls.key_file

optional string literal

Absolute path to a private key file used to identify this server.

The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.

Examples

"/path/to/host_certificate.key"

tls.key_pass

optional string literal

Passphrase used to unlock the encrypted key file.

This has no effect unless key_file is set.

Examples

"${KEY_PASS_ENV_VAR}"

"PassWord1"

tls.server_name

optional string literal

Server name to use when using Server Name Indication (SNI).

Only relevant for outgoing connections.

Examples

"www.example.com"

tls.verify_certificate

optional bool

Enables certificate verification. For components that create a server, this requires that the client connections have a valid client certificate. For components that initiate requests, this validates that the upstream has a valid certificate.

If enabled, certificates must not be expired and must be issued by a trusted issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and so on until the verification process reaches a root certificate.

Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.

tls.verify_hostname

optional bool

Enables hostname verification.

If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.

Only relevant for outgoing connections.

Do NOT set this to false unless you understand the risks of not verifying the remote hostname.

Telemetry

intentional

True if the events were discarded intentionally, like a filter transform, or false if due to an error.

pid optional

The process ID of the Vector instance.

component_errors_total

counter

The total number of errors encountered by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

The Vector component type.

error_type

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

The stage within the component at which the error occurred.

component_received_event_bytes_total

counter

The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

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_count

histogram

A histogram of the number of events passed in each internal batch in Vector’s internal topology.

Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

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

counter

The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

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_bytes_total

counter

The number of raw bytes sent by this component to destination sinks.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

The Vector component type.

endpoint optional

The endpoint to which the bytes were sent. For HTTP, this will be the host and path only, excluding the query string.

file optional

The absolute path of the destination file.

host optional

The hostname of the system Vector is running on.

pid optional

The process ID of the Vector instance.

protocol

The protocol used to send the bytes.

region optional

The AWS region name to which the bytes were sent. In some configurations, this may be a literal hostname.

component_sent_event_bytes_total

counter

The total number of event bytes emitted by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

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

counter

The total number of events emitted by this component.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

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.

utilization

gauge

A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.

component_id

The Vector component ID.

component_kind

The Vector component kind.

component_type

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

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.yaml --require-healthy

Disable health checks

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

Lapin

The amqp source and sink uses lapin under the hood. This is a reliable pure rust library that facilitates communication with AMQP servers such as RabbitMQ.

State

This component is stateless, meaning its behavior is consistent across each input.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols due to OpenSSL’s maturity. You can enable and adjust TLS behavior via the tls.* options and/or via an OpenSSL configuration file. The file location defaults to /usr/local/ssl/openssl.cnf or can be specified with the OPENSSL_CONF environment variable.