NetEvolve.Pulse.Kafka 0.84.106

Prefix Reserved
dotnet add package NetEvolve.Pulse.Kafka --version 0.84.106
                    
NuGet\Install-Package NetEvolve.Pulse.Kafka -Version 0.84.106
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetEvolve.Pulse.Kafka" Version="0.84.106" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="NetEvolve.Pulse.Kafka" Version="0.84.106" />
                    
Directory.Packages.props
<PackageReference Include="NetEvolve.Pulse.Kafka" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add NetEvolve.Pulse.Kafka --version 0.84.106
                    
#r "nuget: NetEvolve.Pulse.Kafka, 0.84.106"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package NetEvolve.Pulse.Kafka@0.84.106
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=NetEvolve.Pulse.Kafka&version=0.84.106
                    
Install as a Cake Addin
#tool nuget:?package=NetEvolve.Pulse.Kafka&version=0.84.106
                    
Install as a Cake Tool

NetEvolve.Pulse.Kafka

Apache Kafka transport for the NetEvolve.Pulse outbox processor.

Delivers outbox messages directly to Kafka topics using the Confluent.Kafka producer.

Getting Started

Register the Confluent.Kafka producer and admin client in DI, then call UseKafkaTransport():

// 1. Register the Confluent.Kafka producer (user's responsibility)
services.AddSingleton<IProducer<string, string>>(sp =>
    new ProducerBuilder<string, string>(
        new ProducerConfig { BootstrapServers = "localhost:9092", Acks = Acks.All })
    .Build());

// 2. Register the admin client (used for topic auto-creation and health checks)
services.AddSingleton<IAdminClient>(sp =>
    new AdminClientBuilder(
        new AdminClientConfig { BootstrapServers = "localhost:9092" })
    .Build());

// 3. Register the Pulse Kafka transport
services.AddPulse(config => config.AddOutbox().UseKafkaTransport());

Topic Routing

Topic names are resolved by the registered ITopicNameResolver. The default implementation (registered by AddOutbox()) returns the Type.Name of OutboxMessage.EventType, which is a System.Type, e.g. an event of type MyApp.Events.OrderCreated resolves to "OrderCreated".

Register a custom ITopicNameResolver before calling UseKafkaTransport() to override:

services.AddSingleton<ITopicNameResolver, MyCustomTopicNameResolver>();
services.AddPulse(config => config.AddOutbox().UseKafkaTransport());

Topic Auto-Creation

AutoCreateTopics is true by default. Before the first message to a topic, the transport calls IAdminClient.CreateTopicsAsync with these KafkaTransportOptions. It caches the topic once creation succeeds, reports TOPIC_ALREADY_EXISTS or is rejected with an authorization error. Any other failure is retried on the next send (once per topic within a batch):

Option Default Description
AutoCreateTopics true Create each topic before its first message.
DefaultPartitionCount 1 Partition count of auto-created topics.
DefaultReplicationFactor 1 Replication factor of auto-created topics. Most production clusters need 3.
MessageRetention null retention.ms of auto-created topics; null uses the broker default.

Creating a topic needs the CREATE ACL on the cluster or on the topic. When the broker answers with TOPIC_AUTHORIZATION_FAILED or CLUSTER_AUTHORIZATION_FAILED, the transport stops trying to create that topic and produces to it anyway. If the topic cannot be described either, it logs a warning. Any other creation error (for example POLICY_VIOLATION or INVALID_REPLICATION_FACTOR) fails the send with an InvalidOperationException that names the topic.

On managed clusters with pre-provisioned topics, turn auto-creation off:

services.AddPulse(config => config.AddOutbox().UseKafkaTransport(options => options.AutoCreateTopics = false));

Notes

  • IProducer<string, string> and IAdminClient must be registered by the caller.
  • IsHealthyAsync queries cluster metadata; returns false when the broker is unreachable.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.84.106 87 11/8/2026
0.70.75 140 7/28/2026
0.70.16 122 7/27/2026
0.70.0 132 7/24/2026
0.67.140 127 7/23/2026
0.67.36 135 5/10/2026