Skip to content

Support for auto-instrumentation of Confluent Kafka .NET Client 2.x #2677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 9, 2025
Merged

Support for auto-instrumentation of Confluent Kafka .NET Client 2.x #2677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3942a9a
Support for auto-instrumentation of Confluent Kafka .NET Client 2.x
JeremyBessonElastic Oct 6, 2025
ffd5ec3
Add documentation
JeremyBessonElastic Oct 8, 2025
a106f40
Update documentation
JeremyBessonElastic Oct 8, 2025
c76d6d4
Fix
JeremyBessonElastic Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<PackageVersion Include="BenchmarkDotNet" Version="0.13.5" />
<PackageVersion Include="Bullseye" Version="3.5.0" />
<PackageVersion Include="CommandLineParser" Version="2.6.0" />
<PackageVersion Include="Confluent.Kafka" Version="1.9.3" />
<PackageVersion Include="Confluent.Kafka" Version="2.11.1" />
<PackageVersion Include="Elastic.Clients.Elasticsearch" Version="8.12.0" />
<PackageVersion Include="Elastic.CommonSchema.BenchmarkDotNetExporter" Version="1.5.0" />
<PackageVersion Include="Elasticsearch.Net" Version="7.17.5" />
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/setup-auto-instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It instruments the following assemblies:
| AdoNet | part of .NET | System.Data 4.0.0 - 4.*.* |
| part of .NET | System.Data.Common 4.0.0 - 5.*.* |
| AspNet | part of .NET Framework | System.Web 4.0.0 - 4.*.* |
| Kafka | [Confluent.Kafka 1.4.0 - 1.*.*](https://www.nuget.org/packages/Confluent.Kafka) | Confluent.Kafka 1.4.0 - 1.*.* |
| Kafka | [Confluent.Kafka 1.4.0 - 2.*.*](https://www.nuget.org/packages/Confluent.Kafka) | Confluent.Kafka 1.4.0 - 2.*.* |
| MySqlCommand | [MySql.Data 6.7.0 - 8.*.*](https://www.nuget.org/packages/MySql.Data) | MySql.Data 6.7.0 - 8.*.* |
| NpgsqlCommand | [Npgsql 4.0.0 - 7.*.*](https://www.nuget.org/packages/Npgsql) | Npgsql 4.0.0 - 7.*.* |
| OracleCommand | [Oracle.ManagedDataAccess 12.2.1100 - 21.*.*](https://www.nuget.org/packages/Oracle.ManagedDataAccess) | Oracle.ManagedDataAccess 4.122.0 - 4.122.* |
Expand Down
21 changes: 21 additions & 0 deletions docs/reference/setup-kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/dotnet/current/setup-kafka.html
applies_to:
stack:
serverless:
observability:
product:
apm_agent_dotnet: ga
---

# Confluent Kafka [setup-kafka]

## Quick start [_get_started]

Instrumentation can be performed for Confluent Kafka by referencing [`Confluent.Kafka`](https://www.nuget.org/packages/confluent.kafka) and [`Confluent.Kafka.Extensions.Diagnostics`](https://www.nuget.org/packages/Confluent.Kafka.Extensions.Diagnostics) packages.

`Confluent.Kafka` is not instrumented automatically but `Confluent.Kafka.Extensions.Diagnostics` provides instrumentations on top of `Confluent.Kafka`.

Please, follow the instructions provided in [`Confluent.Kafka.Extensions.Diagnostics`](https://www.nuget.org/packages/Confluent.Kafka.Extensions.Diagnostics), especially for the `Producer`.

1 change: 1 addition & 0 deletions docs/reference/supported-technologies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ We support automatic instrumentation for the following messaging systems
| Azure.Messaging.ServiceBus 7.0.0+ |
| Azure Queue Storage {applies_to}`apm_agent_dotnet: ga 1.10` | Azure.Storage.Queues 12.6.0+ | [NuGet package](/reference/setup-azure-storage.md) |
| Kafka {applies_to}`apm_agent_dotnet: ga 1.12` | See profiler documentation | [Profiler auto instrumentation](/reference/setup-auto-instrumentation.md) |
| Kafka | Confluent.Kafka 2.11.1 | [NuGet package](/reference/setup-kafka.md) |
| RabbitMQ {applies_to}`apm_agent_dotnet: ga 1.12` | See profiler documentation | [Profiler auto instrumentation](/reference/setup-auto-instrumentation.md) |


Expand Down
1 change: 1 addition & 0 deletions docs/reference/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ toc:
- file: setup-azure-servicebus.md
- file: setup-azure-storage.md
- file: setup-mongo-db.md
- file: setup-kafka.md
- file: supported-technologies.md
- file: configuration.md
children:
Expand Down
2 changes: 1 addition & 1 deletion ...profiler/Elastic.Apm.Profiler.Managed/Integrations/Kafka/KafkaConsumerCloseIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
ReturnType = ClrTypeNames.Void,
ParameterTypes = new string[0],
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion ...ofiler/Elastic.Apm.Profiler.Managed/Integrations/Kafka/KafkaConsumerConsumeIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
ReturnType = KafkaIntegration.ConsumeResultTypeName,
ParameterTypes = new[] { ClrTypeNames.Int32 },
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion ...ofiler/Elastic.Apm.Profiler.Managed/Integrations/Kafka/KafkaConsumerDisposeIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
ReturnType = ClrTypeNames.Void,
ParameterTypes = new string[0],
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion ...er/Elastic.Apm.Profiler.Managed/Integrations/Kafka/KafkaConsumerUnsubscribeIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
ReturnType = ClrTypeNames.Void,
ParameterTypes = new string[0],
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion src/profiler/Elastic.Apm.Profiler.Managed/Integrations/Kafka/KafkaProduceAsyncIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
ReturnType = KafkaIntegration.TaskDeliveryReportTypeName,
ParameterTypes = new[] { KafkaIntegration.TopicPartitionTypeName, KafkaIntegration.MessageTypeName, ClrTypeNames.CancellationToken },
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion ...tic.Apm.Profiler.Managed/Integrations/Kafka/KafkaProduceSyncDeliveryHandlerIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
ReturnType = ClrTypeNames.Void,
ParameterTypes = new[] { ClrTypeNames.String, "!0", "!1", KafkaIntegration.ActionOfDeliveryReportTypeName },
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
2 changes: 1 addition & 1 deletion src/profiler/Elastic.Apm.Profiler.Managed/Integrations/Kafka/KafkaProduceSyncIntegration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace Elastic.Apm.Profiler.Managed.Integrations.Kafka
KafkaIntegration.TopicPartitionTypeName, KafkaIntegration.MessageTypeName, KafkaIntegration.ActionOfDeliveryReportTypeName
},
MinimumVersion = "1.4.0",
MaximumVersion = "1.*.*",
MaximumVersion = "2.*.*",
Group = KafkaIntegration.Name)]
[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
Expand Down
Loading