How-To Guides
Integration Guides

Kafka TCP Integration Guide

9min

YReview the following guide for setting up an integration between Manufacturing Connect Edge and a Kafka broker.

Before You Begin

You will need access to a Kafka-TCP broker.

Refer to the following links to learn more:

Step 1: Set up the Kafka-TCP server

You will need to set up the Kafka server so that it is ready to connect with Manufacturing Connect Edge.

To set up the Kafka-TCP server:

  1. Connect and log in to the Kafka-TCP server.
  2. From the command screen cursor, enter cat docker-compose.yml. The services list appears.
  3. From the cursor, enter docker-compose up. The TCP_Zookeeper and TCP_Kafka start up.

Step 2: Add Device



Step 3: Add Tags



Step 4: Add Kafka TCP Connector

Follow the steps to Add a Connector and select the Kafka TCP provider.

Configure the following parameters.

  • Name: Enter a name for the connector.
  • Brokers list separated by comma: Enter the Kafka broker URL. For example: 192.168.56.1.
  • SASL mechanism: Select an option: NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512.
  • Username (Optional)
  • Password: (Optional)
  • Topic: Enter the name of the default topic used for publishing data.
  • Throttling Limit: The maximum number of messages per second to be processed. The default value is zero, which means that there is no limit.
  • Persistent storage: When enabled, this will cause messages to undergo a store-and-forward procedure. Messages will be stored within Manufacturing Connect Edge when cloud providers are online.
  • Queue Mode: Select the queue mode as lifo (last in first out) or fifo (first in first out). Selecting lifo means that the last data entry is processed first, and selecting fifo means the first data entry is processed first.

Step 5: Enable the Connector

After adding the connector, click the toggle in the connector tile to enable it.

Document image


If you see a Failed status, you can review the Connector Logs and relevant error messages.

Step 6: Create Topics for Connector

You will now need to import the tag you added in Step 3 to the connector as topics.



After adding all required topics, navigate to the Integration overview page and ensure the connector is not disabled and still shows a CONNECTED status.

Step 7: Enable Topics



Step 8: Verify Connection

Access the Kafka broker and verify that Manufacturing Connect Edge is successfully sending data.

Updated 02 May 2024
PREVIOUS
Kafka SSL Integration Guide
NEXT
MongoDB Integration Guide
Docs powered by Archbee