WebSocket Producer

The WebSocket Producer component is used to send data over a WebSocket connection. It allows pipelines to publish live data streams that can be consumed by internal WebSocket clients.

Typical use cases include:

• Streaming Kafka topic messages to a WebSocket endpoint.

• Delivering real-time data feeds to downstream applications.

• Enabling browser-based dashboards or monitoring systems to consume live updates.

Configuration Sections

All component configurations are classified into:

• Basic Information

• Meta Information

• Resource Configuration

• Connection Validation

Workflow

1. Drag and drop the WebSocket Producer component into the Workflow Editor.

2. Create an input event (data can come from any Reader, Consumer, or Shared Event).

3. Connect the input event to the WebSocket Producer.

4. Open the component properties to configure Basic Information and Meta Information.

5. Save the component and update the pipeline.

6. Once saved, the component generates a GUID, Ingestion ID, and Ingestion Secret for authentication.

Basic Information Tab

The Basic Information tab defines execution, scaling, and deployment details.

Field	Description	Required
Invocation Type	Supported value: Real-Time.	Yes
Deployment Type	Displays the deployment type of the component (pre-selected).	Yes
Container Image Version	Displays the Docker image version used (pre-selected).	Yes
Failover Event	Select a failover event to handle retries or errors.	Optional
Batch Size	Maximum number of records processed per cycle (minimum: 10).	Yes
Intelligent Scaling	Automatically scales pods based on lag thresholds (>60% scale up, <10% scale down).	Optional

Meta Information Tab

The Meta Information tab configures authentication and endpoint details.

Field	Description	Required
GUID	Auto-generated after saving the component and updating the pipeline.	Yes
Ingestion ID	Auto-generated when the component is created.	Yes
Ingestion Secret	Auto-generated for the component. Can be regenerated using the Refresh Ingestion icon.	Yes

Saving the Configuration

1. Click Save Component (Storage icon).

2. A success message confirms the update.

3. Click Update Pipeline to apply changes.

Example Workflow

1. Connect a Kafka Consumer to a WebSocket Producer.

2. The Kafka Consumer ingests messages from a topic (e.g., transactions).

3. The WebSocket Producer publishes these messages to a WebSocket endpoint.

4. A dashboard or monitoring app subscribes to the WebSocket to display real-time transaction updates.