Snowberry.Mediator.OpenTelemetry
3.0.0
dotnet add package Snowberry.Mediator.OpenTelemetry --version 3.0.0
NuGet\Install-Package Snowberry.Mediator.OpenTelemetry -Version 3.0.0
<PackageReference Include="Snowberry.Mediator.OpenTelemetry" Version="3.0.0" />
<PackageVersion Include="Snowberry.Mediator.OpenTelemetry" Version="3.0.0" />
<PackageReference Include="Snowberry.Mediator.OpenTelemetry" />
paket add Snowberry.Mediator.OpenTelemetry --version 3.0.0
#r "nuget: Snowberry.Mediator.OpenTelemetry, 3.0.0"
#:package Snowberry.Mediator.OpenTelemetry@3.0.0
#addin nuget:?package=Snowberry.Mediator.OpenTelemetry&version=3.0.0
#tool nuget:?package=Snowberry.Mediator.OpenTelemetry&version=3.0.0
Snowberry.Mediator.OpenTelemetry
OpenTelemetry for Snowberry.Mediator on Snowberry.DependencyInjection. AddSnowberryMediatorOpenTelemetry registers the InstrumentedMediator decorator from Snowberry.Mediator.OpenTelemetry.Shared as the IMediator of an IServiceRegistry, so every dispatch emits spans and metrics. It targets net11.0, net10.0 and netstandard2.0.
For Microsoft.Extensions.DependencyInjection use Snowberry.Mediator.Extensions.OpenTelemetry instead.
Table of Contents
Installation
dotnet add package Snowberry.Mediator.OpenTelemetry
dotnet add package OpenTelemetry # Sdk.CreateTracerProviderBuilder()
dotnet add package OpenTelemetry.Exporter.Console # or the exporter you use
Quick Start
using OpenTelemetry;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;
using Snowberry.DependencyInjection;
using Snowberry.DependencyInjection.Abstractions;
using Snowberry.Mediator.DependencyInjection;
using Snowberry.Mediator.OpenTelemetry;
using var container = new ServiceContainer();
// 1. Register the decorator FIRST.
container.AddSnowberryMediatorOpenTelemetry(options =>
{
options.EnablePipelineBehaviorSpans = true; // optional, off by default
options.EnableNotificationHandlerSpans = true; // optional, off by default
}, lifetime: ServiceLifetime.Scoped);
// 2. Then register the mediator with the same lifetime.
container.AddSnowberryMediator(options =>
{
options.RequestHandlerTypes = [typeof(MyRequestHandler)];
}, ServiceLifetime.Scoped);
// 3. Subscribe the OpenTelemetry SDK to the mediator sources and meter.
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddSnowberryMediatorInstrumentation()
.AddConsoleExporter()
.Build();
using var meterProvider = Sdk.CreateMeterProviderBuilder()
.AddSnowberryMediatorInstrumentation()
.AddConsoleExporter()
.Build();
The full options table, the emitted activities and metrics, and the enrichment hooks are documented in the Snowberry.Mediator.OpenTelemetry.Shared README.
Order of Registration
public static IServiceRegistry AddSnowberryMediatorOpenTelemetry(
this IServiceRegistry registry,
Action<MediatorTelemetryOptions>? configure = null,
ServiceLifetime lifetime = ServiceLifetime.Scoped)
- Call it before
AddSnowberryMediator. The decorator claims theIMediatorregistration first; the mediator registration then skipsIMediator(it uses try-register) and still registers handlers, behaviors and registries. Called afterAddSnowberryMediator, it throwsInvalidOperationException. - Match the lifetimes. Pass the same
lifetimeyou pass toAddSnowberryMediator. - Repeated calls are a no-op.
This is the reverse of the Microsoft DI order, where the decorator is added after the mediator.
Pitfalls
- The inner mediator is always
Snowberry.Mediator.Mediator. A customIMediatorimplementation is not wrapped by this decorator; use the Microsoft DI package, or wireInstrumentedMediatorby hand, to decorate a custom mediator. - A changed
SourceNamemust be passed to both builders (AddSnowberryMediatorInstrumentation(sourceName)), or the SDK listens to the wrong source and meter. - Registering the decorator after the mediator throws. Keep the OpenTelemetry call first, including in modules that set up the container.
Related Packages
| Package | Purpose |
|---|---|
Snowberry.Mediator.OpenTelemetry.Shared |
The decorator, options, conventions and builder extensions. |
Snowberry.Mediator.DependencyInjection |
The mediator registration this package decorates. |
Snowberry.Mediator.Extensions.OpenTelemetry |
The equivalent package for Microsoft.Extensions.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
- Snowberry.DependencyInjection (>= 6.0.0)
- Snowberry.Mediator.OpenTelemetry.Shared (>= 3.0.0)
-
net10.0
- Snowberry.DependencyInjection (>= 6.0.0)
- Snowberry.Mediator.OpenTelemetry.Shared (>= 3.0.0)
-
net11.0
- Snowberry.DependencyInjection (>= 6.0.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.