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.

The payload of the ingested data is encoded as bytes. To deserialize and preview your data, see Deserialize and preview data from Kafka in DSP in the Connect to Data Sources and Destinations with the manual.

Prerequisites

Before you can use this function, you must create a connection.

When configuring this source function, set the connection_id argument to the ID of the connection that you created.

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 in Canvas View: my-kafka-connection
topic
Syntax: string
Description: The name of the Kafka topic.
Example in Canvas View: my-kafka-topic

Optional arguments

consumer_properties
Syntax: "<name>": "<value>"
Description: The consumer properties by which you want to delimit your data. Defaults to empty.
  • When working in Canvas View, specify the name and value of the property in the fields on either side of the equal sign ( = ), and click Add to specify additional properties.
  • When working in SPL View, 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.
Example in Canvas View: name = value

SPL2 example

When working in the SPL View, 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 declare the arguments in any order. 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") |...;

If you want to use a mix of unnamed and named arguments in your functions, you must list all unnamed arguments in the correct order before providing the named arguments.

Last modified on 19 April, 2021
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, 1.2.1


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