Microsoft.Extensions.Diagnostics.ExceptionSummarization 9.0.0

Microsoft.Extensions.Diagnostics.ExceptionSummarization

This provides the ability to extract essential information from well-known exception types and return a single string that can be used to create low-cardinality diagnostic messages for use in telemetry.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.Diagnostics.ExceptionSummarization

Or directly in the C# project file:

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

Usage Example

Registering Services

The services can be registered using the following methods:

public static IServiceCollection AddExceptionSummarizer(this IServiceCollection services)
public static IServiceCollection AddExceptionSummarizer(this IServiceCollection services, Action<IExceptionSummarizationBuilder> configure)

For example:

services.AddExceptionSummarizer();

The package comes with a predefined IExceptionSummaryProvider implementation that handles common exceptions that might be sent during a web request. Here is how to register it:

using Microsoft.Extensions.Diagnostics.ExceptionSummarization;

services.AddExceptionSummarizer(b => b.AddHttpProvider());

Consuming Services

Once registered, the IExceptionSummarizer class can be resolved. For example:

using Microsoft.Extensions.Diagnostics.ExceptionSummarization;

var summarizer = services.BuildServiceProvider().GetRequiredService<IExceptionSummarizer>();

try
{
    throw new SocketException((int)SocketError.NetworkDown);
}
catch (Exception e)
{
    ExceptionSummary summary = summarizer.Summarize(e);

    Console.WriteLine(summary.Description); // writes NetworkDown
}

The ExceptionSummary.Description property never includes sensitive information and can be safely used. As opposed to ExceptionSummary.AdditionalDetails which can contain sensitive information that should not be stored and can only be used for debugging purpose.

Custom exception summarization

Custom implementations of the IExceptionSummaryProvider interface can be used to provide a summary for any type of exception.

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.