Snowberry.Mediator.Extensions.OpenTelemetry
3.0.0
dotnet add package Snowberry.Mediator.Extensions.OpenTelemetry --version 3.0.0
NuGet\Install-Package Snowberry.Mediator.Extensions.OpenTelemetry -Version 3.0.0
<PackageReference Include="Snowberry.Mediator.Extensions.OpenTelemetry" Version="3.0.0" />
<PackageVersion Include="Snowberry.Mediator.Extensions.OpenTelemetry" Version="3.0.0" />
<PackageReference Include="Snowberry.Mediator.Extensions.OpenTelemetry" />
paket add Snowberry.Mediator.Extensions.OpenTelemetry --version 3.0.0
#r "nuget: Snowberry.Mediator.Extensions.OpenTelemetry, 3.0.0"
#:package Snowberry.Mediator.Extensions.OpenTelemetry@3.0.0
#addin nuget:?package=Snowberry.Mediator.Extensions.OpenTelemetry&version=3.0.0
#tool nuget:?package=Snowberry.Mediator.Extensions.OpenTelemetry&version=3.0.0
Snowberry.Mediator.Extensions.OpenTelemetry
OpenTelemetry for Snowberry.Mediator on Microsoft.Extensions.DependencyInjection. AddSnowberryMediatorOpenTelemetry decorates the registered IMediator with the InstrumentedMediator from Snowberry.Mediator.OpenTelemetry.Shared, so every dispatch emits spans and metrics. It targets net11.0, net10.0 and netstandard2.0.
For the Snowberry.DependencyInjection container use Snowberry.Mediator.OpenTelemetry instead.
Table of Contents
Installation
dotnet add package Snowberry.Mediator.Extensions.OpenTelemetry
dotnet add package OpenTelemetry.Extensions.Hosting # AddOpenTelemetry()
dotnet add package OpenTelemetry.Exporter.Console # or the exporter you use
Quick Start
using Microsoft.Extensions.DependencyInjection;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;
using Snowberry.Mediator.Extensions.DependencyInjection;
using Snowberry.Mediator.Extensions.OpenTelemetry;
using Snowberry.Mediator.OpenTelemetry; // AddSnowberryMediatorInstrumentation
var services = new ServiceCollection();
// 1. Register the mediator.
services.AddSnowberryMediator(options =>
{
options.RequestHandlerTypes = [typeof(MyRequestHandler)];
});
// 2. Decorate it (after AddSnowberryMediator).
services.AddSnowberryMediatorOpenTelemetry(options =>
{
options.EnablePipelineBehaviorSpans = true; // optional, off by default
options.EnableNotificationHandlerSpans = true; // optional, off by default
});
// 3. Subscribe the OpenTelemetry SDK to the mediator sources and meter.
services.AddOpenTelemetry()
.WithTracing(tracing => tracing.AddSnowberryMediatorInstrumentation().AddConsoleExporter())
.WithMetrics(metrics => metrics.AddSnowberryMediatorInstrumentation().AddConsoleExporter());
The full options table, the emitted activities and metrics, and the enrichment hooks are documented in the Snowberry.Mediator.OpenTelemetry.Shared README.
Registration Rules
public static IServiceCollection AddSnowberryMediatorOpenTelemetry(
this IServiceCollection services,
Action<MediatorTelemetryOptions>? configure = null)
- Call it after
AddSnowberryMediator. It replaces the existingIMediatorregistration with the decorator; called first, it throwsInvalidOperationExceptionwithout registering anything, so calling it again afterAddSnowberryMediatorworks. The source-generatedAddSnowberryMediator()works the same way. - The decorator keeps the inner mediator's lifetime.
SingletonorScopedis recommended;Transientworks but creates a mediator and a decorator per resolution. - Repeated calls are a no-op. The first call's options win; a later call's
configurecallback does not run.
Pitfalls
- Only the first
IMediatorregistration is decorated. Registering anotherIMediatorafterwards wins in Microsoft DI and bypasses the decorator. - The builder extensions live in
Snowberry.Mediator.OpenTelemetry. Without thatusing,AddSnowberryMediatorInstrumentation()does not resolve. - A changed
SourceNamemust be passed to both builders (AddSnowberryMediatorInstrumentation(sourceName)), or the SDK listens to the wrong source and meter.
Related Packages
| Package | Purpose |
|---|---|
Snowberry.Mediator.OpenTelemetry.Shared |
The decorator, options, conventions and builder extensions. |
Snowberry.Mediator.Extensions.DependencyInjection |
The mediator registration this package decorates. |
Snowberry.Mediator.OpenTelemetry |
The equivalent package for Snowberry.DependencyInjection. |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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 was computed. 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. net11.0 is compatible. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.6)
- Snowberry.Mediator.OpenTelemetry.Shared (>= 3.0.0)
-
net10.0
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.6)
- Snowberry.Mediator.OpenTelemetry.Shared (>= 3.0.0)
-
net11.0
- Snowberry.Mediator.OpenTelemetry.Shared (>= 3.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.