Kafka

Collect logs from Kafka

status: stable role: aggregator delivery: at-least-once acknowledgements: yes egress: stream state: stateless output: log
Page source Edit this page

Configuration

Example configurations 

{
  "sources": {
    "my_source_id": {
      "type": "kafka",
      "acknowledgements": null,
      "bootstrap_servers": "10.14.22.123:9092,10.14.23.332:9092",
      "group_id": "consumer-group-name",
      "key_field": "message_key",
      "topics": [
        "^(prefix1|prefix2)-.+"
      ]
    }
  }
}
[sources.my_source_id]
type = "kafka"
bootstrap_servers = "10.14.22.123:9092,10.14.23.332:9092"
group_id = "consumer-group-name"
key_field = "message_key"
topics = [ "^(prefix1|prefix2)-.+" ]

---
sources:
  my_source_id:
    type: kafka
    acknowledgements: null
    bootstrap_servers: 10.14.22.123:9092,10.14.23.332:9092
    group_id: consumer-group-name
    key_field: message_key
    topics:
      - ^(prefix1|prefix2)-.+

{
  "sources": {
    "my_source_id": {
      "type": "kafka",
      "acknowledgements": null,
      "auto_offset_reset": "largest",
      "bootstrap_servers": "10.14.22.123:9092,10.14.23.332:9092",
      "commit_interval_ms": 5000,
      "fetch_wait_max_ms": 100,
      "group_id": "consumer-group-name",
      "key_field": "message_key",
      "topic_key": "topic",
      "partition_key": "partition",
      "offset_key": "offset",
      "headers_key": "headers",
      "librdkafka_options": {
        "client.id": "${ENV_VAR}",
        "fetch.error.backoff.ms": "1000",
        "socket.send.buffer.bytes": "100"
      },
      "sasl": null,
      "session_timeout_ms": 10000,
      "socket_timeout_ms": 60000,
      "framing": null,
      "tls": null,
      "topics": [
        "^(prefix1|prefix2)-.+"
      ],
      "decoding": null
    }
  }
}
[sources.my_source_id]
type = "kafka"
auto_offset_reset = "largest"
bootstrap_servers = "10.14.22.123:9092,10.14.23.332:9092"
commit_interval_ms = 5_000
fetch_wait_max_ms = 100
group_id = "consumer-group-name"
key_field = "message_key"
topic_key = "topic"
partition_key = "partition"
offset_key = "offset"
headers_key = "headers"
session_timeout_ms = 10_000
socket_timeout_ms = 60_000
topics = [ "^(prefix1|prefix2)-.+" ]

  [sources.my_source_id.librdkafka_options]
  "client.id" = "${ENV_VAR}"
  "fetch.error.backoff.ms" = "1000"
  "socket.send.buffer.bytes" = "100"

---
sources:
  my_source_id:
    type: kafka
    acknowledgements: null
    auto_offset_reset: largest
    bootstrap_servers: 10.14.22.123:9092,10.14.23.332:9092
    commit_interval_ms: 5000
    fetch_wait_max_ms: 100
    group_id: consumer-group-name
    key_field: message_key
    topic_key: topic
    partition_key: partition
    offset_key: offset
    headers_key: headers
    librdkafka_options:
      client.id: ${ENV_VAR}
      fetch.error.backoff.ms: "1000"
      socket.send.buffer.bytes: "100"
    sasl: null
    session_timeout_ms: 10000
    socket_timeout_ms: 60000
    framing: null
    tls: null
    topics:
      - ^(prefix1|prefix2)-.+
    decoding: null

acknowledgements

common optional object
Controls how acknowledgements are handled by this source. These settings override the global acknowledgement settings. This setting is deprecated in favor of enabling acknowledgements in the destination sink.

acknowledgements.enabled

common optional bool
Controls if the source will wait for destination sinks to deliver the events before acknowledging receipt.
default: false

auto_offset_reset

optional string literal
If offsets for consumer group do not exist, set them using this strategy. See the librdkafka documentation for the auto.offset.reset option for further clarification.
Examples 
"smallest"
"earliest"
"beginning"
"largest"
"latest"
"end"
"error"
default: largest

bootstrap_servers

required string literal
A comma-separated list of host and port pairs that are the addresses of the Kafka brokers in a “bootstrap” Kafka cluster that a Kafka client connects to initially to bootstrap itself.
Examples 
"10.14.22.123:9092,10.14.23.332:9092"

commit_interval_ms

optional uint
The frequency that the consumer offsets are committed (written) to offset storage.
Examples 
5000
10000
default: 5000 (milliseconds)

decoding

optional object
Configures how events are decoded from raw bytes.

decoding.codec

common optional string literal enum
The codec to use for decoding events.
Enum options
OptionDescription
bytesUses the raw bytes as-is.
gelfDecodes the raw bytes as a GELF message.
jsonDecodes the raw bytes as JSON.
native

Decodes the raw bytes as Vector’s native Protocol Buffers format.

This codec is experimental.

native_json

Decodes the raw bytes as Vector’s native JSON format.

This codec is experimental.

syslog

Decodes the raw bytes as a Syslog message.

Will decode either as the RFC 3164-style format (“old” style) or the more modern RFC 5424-style format (“new” style, includes structured data).

default: bytes

fetch_wait_max_ms

optional uint
Maximum time the broker may wait to fill the response.
Examples 
50
100
default: 100 (milliseconds)

framing

optional object
Configures in which way incoming byte sequences are split up into byte frames.

framing.character_delimited

required object
Options for character_delimited framing.
Relevant when: method = `character_delimited`
framing.character_delimited.delimiter
required ascii_char
The character used to separate frames.
Examples 
"\n"
"\t"
framing.character_delimited.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

framing.method

common optional string literal enum
The framing method.
Enum options
OptionDescription
bytesByte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages or stream segments).
character_delimitedByte frames which are delimited by a chosen character.
length_delimitedByte frames which are prefixed by an unsigned big-endian 32-bit integer indicating the length.
newline_delimitedByte frames which are delimited by a newline character.
octet_countingByte frames according to the octet counting format.
default: bytes

framing.newline_delimited

optional object
Options for newline_delimited framing.
Relevant when: method = `newline_delimited`
framing.newline_delimited.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

framing.octet_counting

optional object
Options for octet_counting framing.
Relevant when: method = `octet_counting`
framing.octet_counting.max_length
optional uint
The maximum frame length limit. Any frames longer than max_length bytes will be discarded entirely.
Examples 
65535
102400

group_id

required string literal
The consumer group name to be used to consume events from Kafka.
Examples 
"consumer-group-name"

headers_key

optional string literal
The log field name to use for the Kafka headers.
Examples 
"headers"
default: headers

key_field

common optional string literal
The log field name to use for the Kafka message key.
Examples 
"message_key"
default: message_key

librdkafka_options

optional object
Advanced options. See librdkafka documentation for details.

offset_key

optional string literal
The log field name to use for the Kafka offset.
Examples 
"offset"
default: offset

partition_key

optional string literal
The log field name to use for the Kafka partition name.
Examples 
"partition"
default: partition

sasl

optional object
Options for SASL/SCRAM authentication support.

sasl.enabled

common optional bool
Enable SASL/SCRAM authentication to the remote (not supported on Windows at this time).

sasl.mechanism

common optional string literal
The Kafka SASL/SCRAM mechanisms.
Examples 
"SCRAM-SHA-256"
"SCRAM-SHA-512"

sasl.password

common optional string literal
The Kafka SASL/SCRAM authentication password.
Examples 
"password"

sasl.username

common optional string literal
The Kafka SASL/SCRAM authentication username.
Examples 
"username"

session_timeout_ms

optional uint
The Kafka session timeout in milliseconds.
Examples 
5000
10000
default: 10000 (milliseconds)

socket_timeout_ms

optional uint
Default timeout for network requests.
Examples 
30000
60000
default: 60000 (milliseconds)

tls

optional object
Configures the TLS options for incoming/outgoing connections.

tls.alpn_protocols

optional [string]

Sets the list of supported ALPN protocols.

Declare the supported ALPN protocols, which are used during negotiation with peer. Prioritized in the order 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

common 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.enabled

common optional bool

Whether or not to require TLS for incoming/outgoing connections.

When enabled and used for incoming connections, an identity certificate is also required. See tls.crt_file for more information.

default: false

tls.key_file

common 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"

topic_key

optional string literal
The log field name to use for the Kafka topic.
Examples 
"topic"
default: topic

topics

required [string]
The Kafka topics names to read events from. Regex is supported if the topic begins with ^.
Array string literal
Examples 
[
  "^(prefix1|prefix2)-.+",
  "topic-1",
  "topic-2"
]

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.

Output Data

Logs

Record

An individual Kafka record
Fields
message required string literal
The raw line from the Kafka record.
Examples
53.126.150.246 - - [01/Oct/2020:11:25:58 -0400] "GET /disintermediate HTTP/2.0" 401 20308
offset required uint
The Kafka offset at the time the record was retrieved.
Examples
100
partition required string literal
The Kafka partition that the record came from.
Examples
partition
source_type required string literal
The name of the source type.
Examples
kafka
timestamp required timestamp
The timestamp encoded in the Kafka message or the current time if it cannot be fetched.
Examples
2020-10-10T17:07:36.452332Z
topic required string literal
The Kafka topic that the record came from.
Examples
topic

Telemetry

Metrics

link

component_discarded_events_total

counter
The number of events dropped by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_bytes_total

counter
The number of raw bytes accepted by this component from source origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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_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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_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_name
Deprecated, use component_id instead. The value is the same as component_id.
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_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

consumer_offset_updates_failed_total

counter
The total number of failures to update a Kafka consumer offset.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

events_failed_total

counter
The total number of failures to read a Kafka message.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

events_in_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins. This metric is deprecated and will be removed in a future version. Use component_received_events_total instead.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

events_out_total

counter
The total number of events emitted by this component. This metric is deprecated and will be removed in a future version. Use component_sent_events_total instead.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_consumed_messages_bytes_total

counter
Total number of message bytes (including framing) received from Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_consumed_messages_total

counter
Total number of messages consumed, not including ignored messages (due to offset, etc), from Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_produced_messages_bytes_total

counter
Total number of message bytes (including framing, such as per-Message framing and MessageSet/batch framing) transmitted to Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_produced_messages_total

counter
Total number of messages transmitted (produced) to Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_queue_messages

gauge
Current number of messages in producer queues.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_queue_messages_bytes

gauge
Current total size of messages in producer queues.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_requests_bytes_total

counter
Total number of bytes transmitted to Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_requests_total

counter
Total number of requests sent to Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_responses_bytes_total

counter
Total number of bytes received from Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

kafka_responses_total

counter
Total number of responses received from Kafka brokers.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

processed_bytes_total

counter
The number of bytes processed by the component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
component_type
The Vector component type.
container_name optional
The name of the container from which the bytes originate.
file optional
The file from which the bytes originate.
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 bytes originate.
peer_path optional
The pathname from which the bytes originate.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the bytes originate.
uri optional
The sanitized URI from which the bytes originate.

processed_events_total

counter
The total number of events processed by this component. This metric is deprecated in place of using component_received_events_total and component_sent_events_total metrics.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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.

source_lag_time_seconds

histogram
The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_name
Deprecated, use component_id instead. The value is the same as component_id.
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

Azure Event Hubs

It is possible to use the kafka source and sink with Azure Event Hubs for all tiers other than the Basic tier. More details can be found here. To configure the source and sink to connect to Azure Event Hubs set the following options:

  • bootstrap_servers - <namespace name>.servicebus.windows.net:9093
  • group_id - The consumer group. Note that if the default group ($Default) is used it must be specified as $$Default to escape the $ used for environment variables.
  • topics - The event hub name.
  • sasl.enabled - Set to true.
  • sasl.mechanism - Set to PLAIN.
  • sasl.username - Set to $$ConnectionString (note the double $$).
  • sasl.password - Set to the connection string. See here.
  • tls.enabled - Set to true.
  • tls.ca_file - The certificate authority file.
  • tls.verify_certificate - Set to true.

Context

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

librdkafka

The kafka sink uses librdkafka under the hood. This is a battle-tested, high performance, and reliable library that facilitates communication with Kafka. As Vector produces static MUSL builds, this dependency is packaged with Vector, meaning you do not need to install it.

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