Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/confluentinc/confluent-kafka-dotnet

Confluent's Apache Kafka .NET client
https://github.com/confluentinc/confluent-kafka-dotnet

c-sharp confluent dotnet kafka kafka-client kafka-clients nuget

Last synced: 12 days ago
JSON representation

Confluent's Apache Kafka .NET client

Awesome Lists containing this project

README 

        
Confluent's .NET Client for Apache KafkaTM

=====================================================



[![Build status](https://ci.appveyor.com/api/projects/status/kux83eykufuv16cn/branch/master?svg=true)](https://ci.appveyor.com/project/ConfluentClientEngineering/confluent-kafka-dotnet/branch/master)

[![Chat on Slack](https://img.shields.io/badge/chat-on%20slack-7A5979.svg)](https://launchpass.com/confluentcommunity)



**confluent-kafka-dotnet** is Confluent's .NET client for [Apache Kafka](http://kafka.apache.org/) and the

[Confluent Platform](https://www.confluent.io/product/).



Features:



- **High performance** - confluent-kafka-dotnet is a lightweight wrapper around

[librdkafka](https://github.com/edenhill/librdkafka), a finely tuned C

client.



- **Reliability** - There are a lot of details to get right when writing an Apache Kafka

client. We get them right in one place (librdkafka) and leverage this work

across all of our clients (also [confluent-kafka-python](https://github.com/confluentinc/confluent-kafka-python)

and [confluent-kafka-go](https://github.com/confluentinc/confluent-kafka-go)).



- **Supported** - Commercial support is offered by

[Confluent](https://confluent.io/).



- **Future proof** - Confluent, founded by the

original creator/co-creator of Kafka, is building a [streaming platform](https://www.confluent.io/product/)

with Apache Kafka at its core. It's high priority for us that client features keep

pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/).



confluent-kafka-dotnet is derived from Andreas Heider's [rdkafka-dotnet](https://github.com/ah-/rdkafka-dotnet).

We're fans of his work and were very happy to have been able to leverage rdkafka-dotnet as the basis of this

client. Thanks Andreas!



## Referencing



confluent-kafka-dotnet is distributed via NuGet. We provide the following  packages:



- [Confluent.Kafka](https://www.nuget.org/packages/Confluent.Kafka/) *[netstandard2.0, net6.0, net8.0]* - The core client library.

- [Confluent.SchemaRegistry.Serdes.Avro](https://www.nuget.org/packages/Confluent.SchemaRegistry.Serdes.Avro/) *[netstandard2.0, net6.0, net8.0]* - Provides a serializer and deserializer for working with Avro serialized data with Confluent Schema Registry integration.

- [Confluent.SchemaRegistry.Serdes.Protobuf](https://www.nuget.org/packages/Confluent.SchemaRegistry.Serdes.Protobuf/) *[netstandard2.0, net6.0, net8.0]* - Provides a serializer and deserializer for working with Protobuf serialized data with Confluent Schema Registry integration.

- [Confluent.SchemaRegistry.Serdes.Json](https://www.nuget.org/packages/Confluent.SchemaRegistry.Serdes.Json/) *[netstandard2.0, net6.0, net8.0]* - Provides a serializer and deserializer for working with Json serialized data with Confluent Schema Registry integration.

- [Confluent.SchemaRegistry](https://www.nuget.org/packages/Confluent.SchemaRegistry/) *[netstandard2.0, net6.0, net8.0]* - Confluent Schema Registry client (a dependency of the Confluent.SchemaRegistry.Serdes packages).

- [Confluent.SchemaRegistry.Encryption](https://www.nuget.org/packages/Confluent.SchemaRegistry.Encryption/) *[net6.0, net8.0]* - Confluent Schema Registry client-side field-level encryption client (a dependency of the other Confluent.SchemaRegistry.Encryption.* packages).

- [Confluent.SchemaRegistry.Encryption.Aws](https://www.nuget.org/packages/Confluent.SchemaRegistry.Encryption.Aws/) *[net6.0, net8.0]* - Confluent Schema Registry client-side field-level encryption client for AWS KMS.

- [Confluent.SchemaRegistry.Encryption.Azure](https://www.nuget.org/packages/Confluent.SchemaRegistry.Encryption.Azure/) *[net6.0, net8.0]* - Confluent Schema Registry client-side field-level encryption client for Azure Key Vault.

- [Confluent.SchemaRegistry.Encryption.Gcp](https://www.nuget.org/packages/Confluent.SchemaRegistry.Encryption.Gcp/) *[net6.0, net8.0]* - Confluent Schema Registry client-side field-level encryption client for Google Cloud KMS.

- [Confluent.SchemaRegistry.Encryption.HcVault](https://www.nuget.org/packages/Confluent.SchemaRegistry.Encryption.HcVault/) *[net6.0, net8.0]* - Confluent Schema Registry client-side field-level encryption client for Hashicorp Vault.

- [Confluent.SchemaRegistry.Rules](https://www.nuget.org/packages/Confluent.SchemaRegistry.Rules/) *[net6.0, net8.0]* - Confluent Schema Registry client-side support for data quality rules (via the Common Expression Language) and schema migration rules (via JSONata).



To install Confluent.Kafka from within Visual Studio, search for Confluent.Kafka in the NuGet Package Manager UI, or run the following command in the Package Manager Console:



```

Install-Package Confluent.Kafka -Version 2.6.0

```



To add a reference to a dotnet core project, execute the following at the command line:



```

dotnet add package -v 2.6.0 Confluent.Kafka

```



Note: `Confluent.Kafka` depends on the `librdkafka.redist` package which provides a number of different builds of `librdkafka` that are compatible with [common platforms](https://github.com/edenhill/librdkafka/wiki/librdkafka.redist-NuGet-package-runtime-libraries). If you are on one of these platforms this will all work seamlessly (and you don't need to explicitly reference `librdkafka.redist`). If you are on a different platform, you may need to [build librdkafka](https://github.com/edenhill/librdkafka#building) manually (or acquire it via other means) and load it using the [Library.Load](https://docs.confluent.io/current/clients/confluent-kafka-dotnet/api/Confluent.Kafka.Library.html#Confluent_Kafka_Library_Load_System_String_) method.



### Branch builds



Nuget packages corresponding to all commits to release branches are available from the following nuget package source (Note: this is not a web URL - you

should specify it in the nuget package manager):

[https://ci.appveyor.com/nuget/confluent-kafka-dotnet](https://ci.appveyor.com/nuget/confluent-kafka-dotnet). The version suffix of these nuget packages

matches the appveyor build number. You can see which commit a particular build number corresponds to by looking at the

[AppVeyor build history](https://ci.appveyor.com/project/ConfluentClientEngineering/confluent-kafka-dotnet/history)



## Usage



For a step-by-step guide and code samples, see [Getting Started with Apache Kafka and .NET](https://developer.confluent.io/get-started/dotnet/) on [Confluent Developer](https://developer.confluent.io/).



You can also take the free self-paced training course [Apache Kafka for .NET Developers](https://developer.confluent.io/learn-kafka/apache-kafka-for-dotnet/) on [Confluent Developer](https://developer.confluent.io/).



Take a look in the [examples](examples) directory and at the [integration tests](test/Confluent.Kafka.IntegrationTests/Tests) for further examples.



For an overview of configuration properties, refer to the [librdkafka documentation](https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md).



### Basic Producer Examples



You should use the `ProduceAsync` method if you would like to wait for the result of your produce

requests before proceeding. You might typically want to do this in highly concurrent scenarios,

for example in the context of handling web requests. Behind the scenes, the client will manage

optimizing communication with the Kafka brokers for you, batching requests as appropriate.



```csharp

using System;

using System.Threading.Tasks;

using Confluent.Kafka;



class Program

{

    public static async Task Main(string[] args)

    {

        var config = new ProducerConfig { BootstrapServers = "localhost:9092" };



        // If serializers are not specified, default serializers from

        // `Confluent.Kafka.Serializers` will be automatically used where

        // available. Note: by default strings are encoded as UTF8.

        using (var p = new ProducerBuilder(config).Build())

        {

            try

            {

                var dr = await p.ProduceAsync("test-topic", new Message { Value = "test" });

                Console.WriteLine($"Delivered '{dr.Value}' to '{dr.TopicPartitionOffset}'");

            }

            catch (ProduceException e)

            {

                Console.WriteLine($"Delivery failed: {e.Error.Reason}");

            }

        }

    }

}

```



Note that a server round-trip is slow (3ms at a minimum; actual latency depends on many factors).

In highly concurrent scenarios you will achieve high overall throughput out of the producer using

the above approach, but there will be a delay on each `await` call. In stream processing

applications, where you would like to process many messages in rapid succession, you would typically

use the `Produce` method instead:



```csharp

using System;

using Confluent.Kafka;



class Program

{

    public static void Main(string[] args)

    {

        var conf = new ProducerConfig { BootstrapServers = "localhost:9092" };



        Action> handler = r =>

            Console.WriteLine(!r.Error.IsError

                ? $"Delivered message to {r.TopicPartitionOffset}"

                : $"Delivery Error: {r.Error.Reason}");



        using (var p = new ProducerBuilder(conf).Build())

        {

            for (int i = 0; i < 100; ++i)

            {

                p.Produce("my-topic", new Message { Value = i.ToString() }, handler);

            }



            // wait for up to 10 seconds for any inflight messages to be delivered.

            p.Flush(TimeSpan.FromSeconds(10));

        }

    }

}

```



### Basic Consumer Example



```csharp

using System;

using System.Threading;

using Confluent.Kafka;



class Program

{

    public static void Main(string[] args)

    {

        var conf = new ConsumerConfig

        {

            GroupId = "test-consumer-group",

            BootstrapServers = "localhost:9092",

            // Note: The AutoOffsetReset property determines the start offset in the event

            // there are not yet any committed offsets for the consumer group for the

            // topic/partitions of interest. By default, offsets are committed

            // automatically, so in this example, consumption will only start from the

            // earliest message in the topic 'my-topic' the first time you run the program.

            AutoOffsetReset = AutoOffsetReset.Earliest

        };



        using (var c = new ConsumerBuilder(conf).Build())

        {

            c.Subscribe("my-topic");



            CancellationTokenSource cts = new CancellationTokenSource();

            Console.CancelKeyPress += (_, e) => {

                // Prevent the process from terminating.

                e.Cancel = true;

                cts.Cancel();

            };



            try

            {

                while (true)

                {

                    try

                    {

                        var cr = c.Consume(cts.Token);

                        Console.WriteLine($"Consumed message '{cr.Value}' at: '{cr.TopicPartitionOffset}'.");

                    }

                    catch (ConsumeException e)

                    {

                        Console.WriteLine($"Error occured: {e.Error.Reason}");

                    }

                }

            }

            catch (OperationCanceledException)

            {

                // Ensure the consumer leaves the group cleanly and final offsets are committed.

                c.Close();

            }

        }

    }

}

```



### IHostedService and Web Application Integration



The [Web](https://github.com/confluentinc/confluent-kafka-dotnet/tree/master/examples/Web) example demonstrates how to integrate

Apache Kafka with a web application, including how to implement `IHostedService` to realize a long running consumer poll loop, how to

register a producer as a singleton service, and how to bind configuration from an injected `IConfiguration` instance.



### Exactly Once Processing



The .NET Client has full support for transactions and idempotent message production, allowing you to write horizontally scalable stream

processing applications with exactly once semantics. The [ExactlyOnce](examples/ExactlyOnce) example demonstrates this capability by way

of an implementation of the classic "word count" problem, also demonstrating how to use the [FASTER](https://github.com/microsoft/FASTER)

Key/Value store (similar to RocksDb) to materialize working state that may be larger than available memory, and incremental rebalancing

to avoid stop-the-world rebalancing operations and unnecessary reloading of state when you add or remove processing nodes.



### Schema Registry Integration



The three "Serdes" packages provide serializers and deserializers for Avro, Protobuf and JSON with [Confluent Schema Registry](https://docs.confluent.io/current/schema-registry/docs/index.html) integration. The `Confluent.SchemaRegistry` nuget package provides a client for interfacing with

Schema Registry's REST API.



**Note:** All three serialization formats are supported across Confluent Platform. They each make different tradeoffs, and you should use the one that best matches to your requirements. Avro is well suited to the streaming data use-case, but the **quality** and **maturity** of the non-Java implementations lags that of Java - this is an important consideration. Protobuf and JSON both have great support in .NET.



### Error Handling



Errors delivered to a client's error handler should be considered informational except when the `IsFatal` flag

is set to `true`, indicating that the client is in an un-recoverable state. Currently, this can only happen on

the producer, and only when `enable.idempotence` has been set to `true`. In all other scenarios, clients will

attempt to recover from all errors automatically.



Although calling most methods on the clients will result in a fatal error if the client is in an un-recoverable

state, you should generally only need to explicitly check for fatal errors in your error handler, and handle

this scenario there.



#### Producer



When using `Produce`, to determine whether a particular message has been successfully delivered to a cluster,

check the `Error` field of the `DeliveryReport` during the delivery handler callback.



When using `ProduceAsync`, any delivery result other than `NoError` will cause the returned `Task` to be in the

faulted state, with the `Task.Exception` field set to a `ProduceException` containing information about the message

and error via the `DeliveryResult` and `Error` fields. Note: if you `await` the call, this means a `ProduceException`

will be thrown.



#### Consumer



All `Consume` errors will result in a `ConsumeException` with further information about the error and context

available via the `Error` and `ConsumeResult` fields.



### 3rd Party



There are numerous libraries that expand on the capabilities provided by Confluent.Kafka, or use Confluent.Kafka

to integrate with Kafka. For more information, refer to the [3rd Party Libraries](3RD_PARTY.md) page.



### Confluent Cloud



For a step-by-step guide on using the .NET client with Confluent Cloud see [Getting Started with Apache Kafka and .NET](https://developer.confluent.io/get-started/dotnet/) on [Confluent Developer](https://developer.confluent.io/).



You can also refer to the [Confluent Cloud example](examples/ConfluentCloud) which demonstrates how to configure the .NET client for use with

[Confluent Cloud](https://www.confluent.io/confluent-cloud/).



### Developer Notes



Instructions on building and testing confluent-kafka-dotnet can be found [here](DEVELOPER.md).



Copyright (c)

2016-2019 [Confluent Inc.](https://www.confluent.io)

2015-2016 [Andreas Heider](mailto:[email protected])



KAFKA is a registered trademark of The Apache Software Foundation and has been licensed for use

by confluent-kafka-dotnet. confluent-kafka-dotnet has no affiliation with and is not endorsed by

The Apache Software Foundation.