Oakrey.Applications.Telemetry 2.0.6

Oakrey.Applications.Telemetry

A Windows .NET library providing pre-configured OpenTelemetry TracerProvider factories for Console and Seq (OTLP/HTTP) backends, with HTTP client instrumentation and a DI extension for registering a Seq trace provider.

NuGet package ID: Oakrey.Applications.Telemetry

Main features

• TracerProviders.ConsoleTraceProvider(sourceName) � builds a TracerProvider that exports traces to the console
• TracerProviders.SeqTraceProvider(sourceName) � builds a TracerProvider that exports to Seq via OTLP/HTTP (localhost:5341) and to the console, with HttpClient instrumentation enabled
• AddSeqTraceProvider(IServiceCollection, sourceName) DI extension � registers the Seq provider as a singleton
• Service resource metadata automatically set to sourceName in all providers
• Hardcoded Seq endpoint: http://localhost:5341/ingest/otlp/v1/traces (OTLP HTTP/Protobuf)

Architecture

classDiagram
    class TracerProviders {
        +ConsoleTraceProvider(sourceName) TracerProvider
        +SeqTraceProvider(sourceName) TracerProvider
        -AddSeqExporter(builder) TracerProviderBuilder
    }

    class TelemetryConfigurationExtensions {
        +AddSeqTraceProvider(services, sourceName) IServiceCollection
    }

    TelemetryConfigurationExtensions --> TracerProviders : calls SeqTraceProvider

Project files

Requirements

• .NET 10 (Windows only � net10.0-windows)
• A running Seq instance on localhost:5341 when using the Seq provider

Dependencies

Installation

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
3. Search for Oakrey.Applications.Telemetry and click Install.

.NET CLI

dotnet add package Oakrey.Applications.Telemetry

Package Manager Console

Install-Package Oakrey.Applications.Telemetry

Configuration

The Seq OTLP endpoint is hardcoded to http://localhost:5341/ingest/otlp/v1/traces. No external configuration file is required. To target a different Seq instance, call TracerProviders.SeqTraceProvider is not directly configurable from outside � see Development notes below.

Example usage

Console exporter only

using OpenTelemetry.Trace;
using Oakrey.Applications.Telemetry;

TracerProvider provider = TracerProviders.ConsoleTraceProvider("MyApplication");

ActivitySource source = new("MyApplication");
using Activity? activity = source.StartActivity("DoWork");
activity?.SetTag("key", "value");

Seq exporter with HTTP client instrumentation

using OpenTelemetry.Trace;
using Oakrey.Applications.Telemetry;

TracerProvider provider = TracerProviders.SeqTraceProvider("MyApplication");

Dependency Injection registration

using Oakrey.Applications.Telemetry;

IServiceCollection services = new ServiceCollection();
services.AddSeqTraceProvider("MyApplication");

Development notes

• The Seq OTLP endpoint (localhost:5341) is hardcoded in TracerProviders.AddSeqExporter. To make it configurable, extract the URI into a parameter or options object.
• OpenTelemetry.Instrumentation.AspNetCore is listed as a package reference but AddAspNetCoreInstrumentation() is not called anywhere in the current source. It is a transitive dependency only.
• TracerProvider implements IDisposable. Providers created via the static factories must be disposed by the caller when the application exits.
• Both ConsoleTraceProvider and SeqTraceProvider call .Build() immediately � they are not lazy.

License

MIT - Copyright (c) Oakrey 2016-present