# Kafka

Category: Queue
|
Runtime: 0.9+
|
Available: Free

# Overview

Kafka node is a client for integrating with Kafka broker and facilitates to publish messages to a Kafka topic.

# Setup

# Prerequisites

For Kafka node to work properly, you need to have an Kafka cloud instance like Confluent Cloud (opens new window) or an On-premise instance of Kafka cluster. Ensure to have necessary connection details and credentials for connecting with the cluster.

# Installation

To install the node from designer:

  1. Go to Add more nodes option on the palette section.
  2. Check for the Kafka node and click install.
  3. Once installed, the designer is required to be restarted.

To install the node from CLI:

  1. Go to your project workspace where you can see your package.json file.
  2. Run the below give npm command.
    npm i @kumologica/kumologica-contrib-kafka

# Technical Details

Properties

  • Client ID (Required)
    String to identify the client. Typically a unique ID that will facilitate to identify the producer of the message.
  • Kafka Topic Name (Required)
    Name of the Kafka topic to publish the message to.
  • Message to Publish (Required)
    Message to be published to the Kafka topic.
  • Broker Name (Required)
    Name of the Kafka broker.
  • Broker Port (Required)
    Kafka broker port. Default Kafka broker port is 9092.

Supported Operations

Not Applicable

Throws

Kafka node throws the following exception.

  • KafkaError

Returns

Payload will not be overwritten by this node.