Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

Kafka Plugin

Overview

Kafka plugin is responsible for sending messages to Kafka brokers triggered by specific rules

Configuration

You can specify following configuration parameters:

Server-side API

This plugin does not provide any server-side API.

Example

In this example we are going to demonstrate how you can configure this extension to be able to send message to Kafka topic every time new telemetry message for the device arrives.

Prerequisites before continue Kafka extension configuration:

Kafka Plugin Configuration

Let’s configure Kafka plugin first. Go to Plugins menu and create new plugin:

image

image

Please set correctly Kafka Bootstrap Servers URL and any other parameters localed in plugin configuration section that are suitable for your case so Kafka extension is able to connect to Kafka broker.

Click on ‘Activate’ plugin button:

image

Kafka Rule Configuration

Now it’s time to create appropriate Rule.

image

Add filter for POST_TELEMETRY message type:

image

Click ‘Add’ button to add filter.

Then select ‘Kafka Plugin’ in the drop-down box for the Plugin field:

image

Add action that will send temperature telemetry of device to particular kafka topic:

image

Click ‘Add’ button and then activate Rule.

Sending Temperature Telemetry

Now for any of your devices send Telemetry message that contains ‘temp’ telemetry:

{"temp":73.4}

You should see ‘73.4’ message in appropriate Kafka topic once you’ll post this message.

Here is an example of a command that publish single telemetry message to locally installed Thingsboard:

mosquitto_pub -d -h "localhost" -p 1883 -t "v1/devices/me/telemetry" -u "$ACCESS_TOKEN" -m '{"temp":73.4}'