Shared.OpenTelemetry 1.0.0

Shared.OpenTelemetry

A comprehensive .NET 9 library for configuring OpenTelemetry observability (logging, metrics, and tracing) in ASP.NET Core and Worker Service applications.

Features

• Easy Setup: Simple two-line integration with ASP.NET Core
• Multi-Environment Support: Automatic configuration for Development, Kubernetes-Aspire, and Kubernetes-Mixed environments
• Comprehensive Telemetry: Logging, metrics, and distributed tracing out-of-the-box
• Extensible: Support for custom activity sources and meters
• Production Ready: Built on OpenTelemetry 1.14.0 with .NET 9 support

Quick Start

ASP.NET Core Applications

var builder = WebApplication.CreateBuilder(args);

// Add OpenTelemetry observability
builder.AddObservability();

var app = builder.Build();

// Configure observability middleware
app.UseObservability();

app.Run();

That's it! Your application now has comprehensive observability configured with:

• Request/response logging and metrics
• Distributed tracing
• Prometheus metrics endpoint at /metrics
• Console logging for development

Custom Telemetry

Add your own metrics and tracing:

// Custom activity source
public class MyActivitySource : IActivitySource
{
    public ActivitySource ActivitySource { get; } = new("MyApp.Operations", "1.0.0");
    public string Name => ActivitySource.Name;
}

// Custom meter
public class MyMeter : IMeter
{
    public string Name => "MyApp.Metrics";
    public string? Version => "1.0.0";
    public Meter Meter { get; } = new("MyApp.Metrics", "1.0.0");
    
    public Counter<int> RequestCounter { get; }
    
    public MyMeter()
    {
        RequestCounter = Meter.CreateCounter<int>("requests_total");
    }
}

// Register with your application
builder.AddObservability(
    activitySources: new[] { new MyActivitySource() },
    meters: new[] { new MyMeter() }
);

Environment Configuration

The library automatically detects your environment and configures appropriate endpoints:

• Development: Uses http://aspire-dashboard:18889 for all telemetry (logs, traces, metrics)
• Production: Uses http://aspire.aspire.svc.cluster.local:18889 for all telemetry in Kubernetes
• Other environments: Falls back to console exporters for logs/traces and Prometheus for metrics

Requirements

• .NET 9.0 or later
• ASP.NET Core (for web applications)

Links

• GitHub Repository
• Package Source