Microsoft.Extensions.Telemetry.Abstractions 9.0.0

Prefix Reserved
dotnet add package Microsoft.Extensions.Telemetry.Abstractions --version 9.0.0                
NuGet\Install-Package Microsoft.Extensions.Telemetry.Abstractions -Version 9.0.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.Abstractions" Version="9.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Telemetry.Abstractions --version 9.0.0                
#r "nuget: Microsoft.Extensions.Telemetry.Abstractions, 9.0.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.Abstractions as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Telemetry.Abstractions&version=9.0.0

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

Microsoft.Extensions.Telemetry.Abstractions

This package contains common abstractions for high-level telemetry primitives. Here are the main features it provides:

  • Enhanced Logging Capabilities
  • Log Enrichment
  • Latency Measurement
  • HTTP Request Metadata Handling

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.Telemetry.Abstractions

Or directly in the C# project file:

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

Usage

Enhanced Logging Capabilities

The package includes a custom logging generator that enhances the default .NET logging capabilities by replacing the default generator. This generator automatically logs the contents of collections and offers advanced logging features, significantly improving the debugging and monitoring process.

[LoggerMessage(1, LogLevel.Information, "These are the contents of my dictionary: {temperature}")]
internal static partial void LogMyDictionary(ILogger<Program> logger, Dictionary<int, string> temperature);

It also adds the LogProperties attribute which can be applied to an object parameter of a LoggerMessage method. It introspects the passed-in object and automatically adds tags for all its properties. This leads to more informative logs without the need for manual tagging of each property.

[LoggerMessage(1, LogLevel.Information, "Detected a new temperature: {temperature}")]
internal static partial void LogNewTemperature(ILogger<Program> logger, [LogProperties] Temperature temperature);

internal record Temperature(double value, TemperatureUnit unit);

Log Enrichment

Logging data can be enriched by adding custom log enrichers to the service collection. This can be done using specific implementations or generic types.

// Using a specific implementation
builder.Services.AddLogEnricher(new CustomLogEnricher());

// Using a generic type
builder.Services.AddLogEnricher<AnotherLogEnricher>();

Create custom log enrichers by implementing the ILogEnricher interface.

public class CustomLogEnricher : ILogEnricher
{
    public void Enrich(IEnrichmentTagCollector collector)
    {
        // Add custom logic to enrich log data
        collector.Add("CustomTag", "CustomValue");
    }
}

Latency Measurement

To track latency in an application it is possible to register checkpoint, measure, and tag names using the following methods:

builder.Services.RegisterCheckpointNames("databaseQuery", "externalApiCall");
builder.Services.RegisterMeasureNames("responseTime", "processingTime");
builder.Services.RegisterTagNames("userId", "transactionId");

Implement the ILatencyDataExporter to export latency data. This can be integrated with external systems or logging frameworks.

public class CustomLatencyDataExporter : ILatencyDataExporter
{
    public async Task ExportAsync(LatencyData data, CancellationToken cancellationToken)
    {
        // Export logic here
    }
}

Use the latency context to track performance metrics in your application.

public void YourMethod(ILatencyContextProvider contextProvider)
{
    var context = contextProvider.CreateContext();
    var checkpointToken = context.GetCheckpointToken("databaseQuery");

    // Start measuring
    context.AddCheckpoint(checkpointToken);

    // Perform operations...

    // End measuring
    context.AddCheckpoint(checkpointToken);

    // Optionally, record measures and tags
    context.RecordMeasure(context.GetMeasureToken("responseTime"), measureValue);
    context.SetTag(context.GetTagToken("userId"), "User123");
}

Http Request Metadata Handling

The IDownstreamDependencyMetadata interface is designed to capture and store metadata about the downstream dependencies of an HTTP request. This is particularly useful for understanding external service dependencies and their impact on your application's performance and reliability.

The IOutgoingRequestContext interface provides a mechanism for associating metadata with outgoing HTTP requests. This allows you to enrich outbound requests with additional information that can be used for logging, telemetry, and analysis.

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

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.  net9.0 is compatible. 
.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 (22)

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

Package Downloads
Microsoft.Extensions.Telemetry

Provides canonical implementations of telemetry abstractions.

Microsoft.Extensions.Resilience

Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.

Microsoft.Extensions.Diagnostics.Testing

Hand-crafted fakes to make telemetry-related testing easier.

Microsoft.Extensions.Diagnostics.ResourceMonitoring

Measures processor and memory usage.

Microsoft.Extensions.Diagnostics.HealthChecks.Common

Health check implementations.

GitHub repositories (1)

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

Repository Stars
open-telemetry/opentelemetry-dotnet
The OpenTelemetry .NET Client
Version Downloads Last updated
9.0.0 570,527 11/12/2024
9.0.0-preview.9.24507.7 43,268 10/8/2024
9.0.0-preview.8.24460.1 30,758 9/10/2024
9.0.0-preview.7.24412.10 10,301 8/14/2024
9.0.0-preview.6.24353.1 9,552 7/10/2024
9.0.0-preview.5.24311.7 6,790 6/11/2024
9.0.0-preview.4.24271.2 11,226 5/21/2024
9.0.0-preview.3.24209.3 19,415 4/11/2024
9.0.0-preview.2.24157.4 4,474 3/12/2024
9.0.0-preview.1.24108.1 3,489 2/13/2024
8.10.0 1,531,647 10/8/2024
8.9.1 1,069,887 9/6/2024
8.9.0 64,962 9/5/2024
8.8.0 844,627 8/13/2024
8.7.0 1,281,234 7/10/2024
8.6.0 935,024 6/11/2024
8.5.0 1,126,449 5/14/2024
8.4.0 1,544,276 4/9/2024
8.3.0 705,748 3/12/2024
8.2.0 1,084,472 2/13/2024
8.1.0 514,213 1/9/2024
8.0.0 1,137,304 11/14/2023
8.0.0-rc.2.23510.2 35,631 10/10/2023
8.0.0-rc.1.23453.1 2,463 9/12/2023
8.0.0-preview.7.23407.5 3,369 8/8/2023
8.0.0-preview.6.23360.2 875 7/12/2023
8.0.0-preview.5.23308.3 2,961 6/14/2023
8.0.0-preview.4.23273.7 3,228 5/23/2023