Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Get data from Kafka

Use the Kafka source function to get data from an Apache or Confluent Kafka topic. See Deserialize and preview data from Kafka in DSP.

This function is available as two different connectors: one that connects to SSL-enabled servers, and another that connects to servers without SSL authentication. See Create an SSL-authenticated DSP connection to Kafka and Create an unauthenticated DSP connection to Kafka.

Function output schema

This function outputs records with the schema described in the following table.

Key Description
key The key of the record in bytes.
value The payload of the record in bytes.
topic The name of the Kafka topic where the record is stored, given as a string.
partition The number of the partition in the Kafka topic where the record is stored, given as an integer.
offset The offset of the record as a long.

The following is an example of a typical record from the kafka function:

{
"key": "YTE=",
"value": "aGVsbG8gd29ybGQ=",
"topic": "my-kafka-topic",
"partition": 1,
"offset": 248
}

Required arguments

connection_id
Syntax: string
Description: The ID of your Kafka connection.
Example: "576205b3-f6f5-4ab7-8ffc-a4089a95d0c4"
topic
Syntax: string
Description: The name of the Kafka topic.
Example: "my-topic"

Optional arguments

consumer_properties
Syntax: "<name>": "<value>"
Description: The consumer properties by which you want to delimit your data. Specify each property using the format "<name>": "<value>", and separate each property with a comma (,). Make sure to enclose the entire argument in braces ({ }). For a list of valid consumer properties, see the "Consumer Configs" section in the Apache Kafka documentation. Defaults to { }.
Example: {"property1": "value1", "property2": "value2"}

SPL2 example

You can write the function by providing the arguments in this exact order.

| from kafka("my-connection-id", "my-topic", {"property1": "value1", "property2": "value2"}) |...;

Alternatively, you can use named arguments to list the arguments in any order. See the "Named arguments" section in SPL2 syntax for more details. The following example uses named arguments to list the optional argument before the required arguments.

| from kafka(consumer_properties: {"property1": "value1", "property2": "value2"}, topic: "my-topic", connection_id: "my-connection-id") |...;
Last modified on 06 October, 2020
PREVIOUS
Get data from Apache Pulsar
  NEXT
Get data from Google Cloud Monitoring

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters