Skip to content

Latest commit

 

History

History
 
 

samples

README.md

Send and Receive Messages in C# using Azure Event Hubs for Apache Kafka Ecosystems

This quickstart will show how to create and connect to an Event Hubs Kafka endpoint using an example producer and consumer written in C# using .NET Core 2.0. Azure Event Hubs for Apache Kafka Ecosystems supports Apache Kafka version 1.0 and later.

This sample is based on Confluent's Apache Kafka .NET client, modified for use with Event Hubs for Kafka.

Prerequisites

If you don't have an Azure subscription, create a free account before you begin.

In addition:

Create an Event Hubs namespace and a schema group

An Event Hubs namespace is required to send or receive from any Event Hubs service. See Create Kafka-enabled Event Hubs for instructions on getting an Event Hubs Kafka endpoint. Make sure to copy the Event Hubs connection string for later use.

Once the namespace is provisioned, head to the Schema Registry tab in the left column and create a schema group. Schema groups must be created before schemas can be auto-registered.

FQDN

For these samples, you will need the connection string from the portal as well as the FQDN that points to your Event Hub namespace. The FQDN can be found within your connection string as follows:

Endpoint=sb://mynamespace.servicebus.windows.net/;SharedAccessKeyName=XXXXXX;SharedAccessKey=XXXXXX

If your Event Hubs namespace is deployed on a non-Public cloud, your domain name may differ (e.g. *.servicebus.chinacloudapi.cn, *.servicebus.usgovcloudapi.net, or *.servicebus.cloudapi.de).

Clone the example project

Now that you have a Kafka-enabled Event Hubs connection string, clone the Azure Event Hubs for Kafka repository and open top-level C$# Avro solution file in Visual Studio.

Import Confluent's Kafka package

Use the NuGet Package Manager UI (or Package Manager Console) with dotnet restore to install the Confluent.Kafka package. More detailed instructions can be found here.

Update App.config

Update the values in App.config:

  • EH_FQDN - Event Hub namespace, with port 9093 appended
  • EH_JAAS_CONFIG - SASL SSL JAAS config for Kafka client
  • EH_NAME - Event Hub name
  • CONSUMER_GROUP- Kafka consumer's group name
  • SCHEMA_REGISTRY_URL - Event Hub namespace hosting Schema Registry instance
  • SCHEMA_REGISTRY_TENANT_ID - Application identity's tenant GUID
  • SCHEMA_REGISTRY_CLIENT_ID - Application identity's client GUID
  • SCHEMA_REGISTRY_CLIENT_SECRET - Client secret for application identity

Run the application

Run the application in Visual Studio! If the Kafka-enabled Event Hub has incoming events, then the consumer should now begin receiving events from the topic set in App.config.

NOTE: Since Kafka's default for an unknown consumer group is to read from the latest offset, the first time you run the consumer will not receive any events from this application's producer. This is because the producer sends its messages before the consumer polls in this application. To remedy this, either run the application several times with the same consumer group (so that the consumer group's offset will be known to the broker), set Kafka's auto.offset.reset consumer config to earliest, or use an external producer and produce simultaneously.

Troubleshooting

Still not working? Here are some helpful tips:

  • Try turning on debugging using librdkafka's debug config: Open up Worker.cs and insert { "debug", "security,broker,protocol" } in your configuration dictionaries (if the problem is specific to the producer or the consumer, just put it in that client's dictionary)
  • Make sure your connection string is at the namespace level (if your connection string ends with "EntityPath=", then it is an EventHub level connection string and will not work)
  • Make sure your topic name is the name of an Event Hub that exists in your namespace
  • If it still doesn't work, feel free to open up an issue on this Github and we'll help as soon as we can!