Microsoft.Extensions.Telemetry 8.5.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Telemetry --version 8.5.0
NuGet\Install-Package Microsoft.Extensions.Telemetry -Version 8.5.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="Microsoft.Extensions.Telemetry" Version="8.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Telemetry --version 8.5.0
#r "nuget: Microsoft.Extensions.Telemetry, 8.5.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 Microsoft.Extensions.Telemetry as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Telemetry&version=8.5.0

// Install Microsoft.Extensions.Telemetry as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Telemetry&version=8.5.0

Microsoft.Extensions.Telemetry

This library provides advanced logging and telemetry enrichment capabilities for .NET applications. It allows for detailed and configurable enrichment of log entries, along with enhanced latency monitoring and logging features. It is built for applications needing sophisticated telemetry and logging insights.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.Telemetry

Or directly in the C# project file:

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Telemetry" Version="[CURRENTVERSION]" />
</ItemGroup>

Usage

Service Log Enrichment

Enriches logs with application-specific information based on ApplicationMetadata information. The bellow calls will add the service log enricher to the service collection.

// Add service log enricher with default settings
builder.Services.AddServiceLogEnricher();

// Or configure with options
builder.Services.AddServiceLogEnricher(options =>
{
    options.ApplicationName = true;
    options.BuildVersion = true;
    options.DeploymentRing = true;
    options.EnvironmentName = true;
});

Latency Monitoring

Provides tools for latency data collection and export. The bellow example uses the built-in Console exporter, but custom exporters can be created by implementing the ILatencyDataExporter interface.

// Add latency console data exporter with configuration
builder.Services.AddConsoleLatencyDataExporter(options =>
{
    options.OutputCheckpoints = true;
    options.OutputMeasures = true;
    options.OutputTags = true;
});

In order for the latency data to be exported, a call to ILatencyDataExporter.ExportAsync() is required. This can either be called manually, or by using the Request Latency Middleware inside the Microsoft.AspNetCore.Diagnostics.Middleware package by adding:

// Add Latency Context
builder.Services.AddLatencyContext();

// Add Checkpoints, Measures, Tags
builder.Services.RegisterCheckpointNames("databaseQuery", "externalApiCall");
builder.Services.RegisterMeasureNames("responseTime", "processingTime");
builder.Services.RegisterTagNames("userId", "transactionId");

// Add Console Latency exporter.
builder.Services.AddConsoleLatencyDataExporter();
// Optionally add custom exporters.
builder.Services.AddSingleton<ILatencyDataExporter, MyCustomExporter>();

// Add Request latency telemetry.
builder.Services.AddRequestLatencyTelemetry();

// ...

// Add Request Latency Middleware which will automatically call ExportAsync on all registered latency exporters.
app.UseRequestLatencyTelemetry();

Logging Enhancements

Offers additional logging capabilities like stack trace capturing, exception message inclusion, and log redaction.

// Enable log enrichment.
builder.Logging.EnableEnrichment(options =>
{
    options.CaptureStackTraces = true;
    options.IncludeExceptionMessage = true;
    options.MaxStackTraceLength = 500;
    options.UseFileInfoForStackTraces = true;
});

builder.Services.AddServiceLogEnricher(); // <- This call is required in order for the enricher to be added into the service collection.

// Enable log redaction
builder.Logging.EnableRedaction(options =>
{
    options.ApplyDiscriminator = true;
});

builder.Services.AddRedaction(); // <- This call is required in order for the redactor provider to be added into the service collection.

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 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. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (10)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Telemetry:

Package Downloads
Microsoft.Extensions.Http.Diagnostics The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Telemetry support for HTTP Client.

Neon.Service

Service library supporting application deployment as containers as well as in-process for testing

Tanka.GraphQL.Server

GraphQL Query, Mutation and Subscription library

Neon.Temporal

Useful classes and extensions for Temporal

Microsoft.AspNetCore.Diagnostics.Middleware The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

ASP.NET Core middleware for collecting high-quality telemetry.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Extensions.Telemetry:

Repository Stars
DataDog/dd-trace-dotnet
.NET Client Library for Datadog APM
Version Downloads Last updated
9.0.0-preview.4.24271.2 533 5/21/2024
9.0.0-preview.3.24209.3 4,034 4/11/2024
9.0.0-preview.2.24157.4 2,982 3/12/2024
9.0.0-preview.1.24108.1 1,914 2/13/2024
8.5.0 46,779 5/14/2024
8.4.0 205,694 4/9/2024
8.3.0 163,983 3/12/2024
8.2.0 391,346 2/13/2024
8.1.0 234,081 1/9/2024
8.0.0 446,976 11/14/2023
8.0.0-rc.2.23510.2 4,478 10/10/2023
8.0.0-rc.1.23453.1 1,745 9/12/2023
8.0.0-preview.7.23407.5 1,162 8/8/2023
8.0.0-preview.6.23360.2 700 7/12/2023
8.0.0-preview.5.23308.3 2,638 6/14/2023
8.0.0-preview.4.23273.7 2,523 5/23/2023