Azure Event Hub Integration Guide
Review the following guide for setting up an integration between Litmus Edge and Azure Event Hub.
The Azure Event Hub connector is based on the Azure official SDK.
Before You Begin
You must have an Azure account.
Step 1: Add a Device
Follow the steps to Connect a DeviceConnect a Device. The device will be used to store tags that will be eventually used to create outbound topics in the connector. Make sure to select the Enable Data Store checkbox.
Step 2: Add Tags
After connecting the device in Litmus Edge, you can Add TagsAdd Tags to the device. Create tags that you want to use to create outbound topics for the connector.
Step 3: Add the Azure Event Hubs Connector
Follow the steps to Add a Connector and select the Azure Event Hubs provider.
Configure the following parameters.
- Name: A recognizable name to identify the connector.
- Connection String: Copy the string from your Azure SAS Policy and paste it here.
- Maximum Message Size: The maximum message size in KB. The default value is 256.
- Parallel Connections Count: The maximum number of parallel connections from your edge device to Azure Event Hub. The default value is 50.
- Combine Messages: Select the checkbox to combine messages (thus reducing the number of parallel connections).
- 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 Litmus 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.
Note: Ensure that you enter the connection string for the Event Hub entity and not the namespace. Using the wrong connection string will result in connection failures. Additionally, verify that the Send and Listen claims are enabled for the SAS policy.
The connection string format should look like this:
Endpoint=sb://<your-event-hub-name>.servicebus.windows.net/;SharedAccessKeyName=<your-policy-name>;SharedAccessKey=<your-access-key>;EntityPath=<your-entity-name>Step 4: Enable the Connector
After adding the connector, click the toggle in the connector tile to enable it.
If you see a Failed status, you can review the Connector Logs and relevant error messages.
Step 5: Add Outbound Topics for Connector
You will now need to create outbound topics for the connector from the tags created in Step 2.
To create outbound topics:
- Click the connector tile. The connector Dashboard appears.
- Click the Topics tab.
- Click the Import from DeviceHub tags icon. The DeviceHub Import dialog box appears.
After importing the tag(s), do the following:
- Edit the tag and configure the Remote Data Topic. Copy and paste the name of your Azure Event Hub.
- Click the Enable toggle to enable the topic.
- Make sure the connector has a CONNECTED status.
Step 6: Verify Connection in Azure
To verify the connection in Azure:
- Open the Azure portal.
Open the Event Hub you have connected to and see statistics on the messages it receives from the Litmus Edge outbound topic.
Azure Event HubNavigate to Process Data > Explore to see the messages in a tabular form.
Explorer view in Azure