AspNet.KickStarter.AddIn.OpenTelemetry 1.2.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package AspNet.KickStarter.AddIn.OpenTelemetry --version 1.2.0                

                    
                

            
NuGet\Install-Package AspNet.KickStarter.AddIn.OpenTelemetry -Version 1.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="AspNet.KickStarter.AddIn.OpenTelemetry" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add AspNet.KickStarter.AddIn.OpenTelemetry --version 1.2.0                

                    
                

            
#r "nuget: AspNet.KickStarter.AddIn.OpenTelemetry, 1.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install AspNet.KickStarter.AddIn.OpenTelemetry as a Cake Addin
#addin nuget:?package=AspNet.KickStarter.AddIn.OpenTelemetry&version=1.2.0

// Install AspNet.KickStarter.AddIn.OpenTelemetry as a Cake Tool
#tool nuget:?package=AspNet.KickStarter.AddIn.OpenTelemetry&version=1.2.0

AspNet.KickStarter.AddIn.OpenTelemetry

This library provides an extension that configures OpenTelemetry for the application.

Sample Usage

Program.cs

await new ApiBuilder()
    .WithOpenTelemetry()
    .Build(args)
    .RunAsync();

Extended Usage

Program.cs

await new ApiBuilder()
    .WithOpenTelemetry(
        prometheusPort: 8081,
        configureTraceBuilder: builder => {...}
        configureMetricsBuilder: builder => {...}
        configureLoggerOptions: options => {...})
    .Build(args)
    .RunAsync();

MyService.cs

public MyService(IMeterFactory meterFactory, ITraceActivity traceActivity)
{
    var meter = meterFactory.CreateAssemblyMeter();
    _traceActivity = traceActivity;

    var subjectName = nameof(MyService).ToLower();

    _count = meter.CreateCounter<long>($"{meter.Name.ToLower()}.{subjectName}.process.count", description: "The number of things processed.");
    
    _duration = meter.CreateHistogram<double>($"{meter.Name.ToLower()}.{subjectName}.process.duration", description: "Time taken to process a thing.", unit: "ms");
}

public Process(Thing thing)
{
    using var trace = _traceActivity.StartActivity("Thing Processing");
    _count.Add(1);
    var stopwatch = Stopwatch.StartNew();
    ...
    _duration.Record(stopwatch.ElapsedMilliseconds);
}

This will instrument the application for metrics and traces to be sent to a collector at the endpoint supplied in the OTEL_EXPORTER_OTLP_ENDPOINT environment variable.

Optionally it can run a listener on a separate port for Prometheus scraping.

A full example can be seen in the AspNet.KickStarter.Demo.DockerCompose project where the information is available in the Aspire dashboard as well as Grafana.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on AspNet.KickStarter.AddIn.OpenTelemetry:

Package Downloads
AspNet.KickStarter

This simplifies the bootstrapping code to run a minimal API with optional AddIn support for Serilog, FluentValidation, OpenTelemetry and Swagger.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.3 78 6/18/2024
1.2.2 215 6/3/2024
1.2.1 36 6/3/2024
1.2.0 36 6/3/2024