Microsoft.Extensions.Diagnostics.ExceptionSummarization 10.10.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.
Showing the top 20 packages that depend on Microsoft.Extensions.Diagnostics.ExceptionSummarization.
| Packages | Downloads |
|---|---|
|
Microsoft.Extensions.Http.Resilience
Resilience mechanisms for HTTP Client.
|
121 |
|
Microsoft.Extensions.Http.Resilience
Resilience mechanisms for HTTP Client.
|
142 |
|
Microsoft.Extensions.Http.Resilience
Resilience mechanisms for HTTP Client.
|
144 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
117 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
118 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
119 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
121 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
122 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
124 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
126 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
129 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
145 |
|
Microsoft.Extensions.Resilience
Extensions to the Polly libraries to enrich telemetry with metadata and exception summaries.
|
149 |
|
Microsoft.Extensions.Resilience
Mechanisms to harden applications against transient failures.
|
117 |
|
Microsoft.Extensions.Resilience
Mechanisms to harden applications against transient failures.
|
126 |
|
Microsoft.Extensions.Resilience
Mechanisms to harden applications against transient failures.
|
130 |
.NET Framework 4.6.2
- Microsoft.Bcl.HashCode (>= 1.1.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- System.Collections.Immutable (>= 8.0.0)
.NET 8.0
.NET 9.0
.NET 10.0
.NET Standard 2.0
- Microsoft.Bcl.HashCode (>= 1.1.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- System.Collections.Immutable (>= 8.0.0)
| Version | Downloads | Last updated |
|---|---|---|
| 10.10.0 | 8 | 09/13/2026 |
| 10.9.0 | 17 | 08/12/2026 |
| 10.8.0 | 23 | 07/15/2026 |
| 10.7.0 | 26 | 06/10/2026 |
| 10.6.0 | 30 | 05/15/2026 |
| 10.5.0 | 34 | 04/15/2026 |
| 10.4.0 | 50 | 03/12/2026 |
| 10.3.0 | 41 | 02/11/2026 |
| 10.2.0 | 51 | 01/14/2026 |
| 10.1.0 | 67 | 12/14/2025 |
| 10.0.0 | 88 | 11/12/2025 |
| 9.10.0 | 94 | 10/15/2025 |
| 9.9.0 | 98 | 09/11/2025 |
| 9.8.0 | 87 | 08/15/2025 |
| 9.7.0 | 105 | 07/10/2025 |
| 9.6.0 | 110 | 06/12/2025 |
| 9.5.0 | 117 | 05/17/2025 |
| 9.4.0 | 130 | 04/10/2025 |
| 9.3.0 | 118 | 04/01/2025 |
| 9.2.0 | 119 | 03/15/2025 |
| 9.1.0 | 117 | 04/01/2025 |
| 9.0.0 | 137 | 04/01/2025 |
| 9.0.0-preview.9.24507.7 | 127 | 04/01/2025 |
| 9.0.0-preview.8.24460.1 | 114 | 04/01/2025 |
| 9.0.0-preview.7.24412.10 | 104 | 03/30/2025 |
| 9.0.0-preview.6.24353.1 | 102 | 04/01/2025 |
| 9.0.0-preview.5.24311.7 | 112 | 04/01/2025 |
| 9.0.0-preview.4.24271.2 | 106 | 03/31/2025 |
| 9.0.0-preview.3.24209.3 | 107 | 04/01/2025 |
| 9.0.0-preview.2.24157.4 | 109 | 04/01/2025 |
| 9.0.0-preview.1.24108.1 | 112 | 04/01/2025 |
| 8.10.0 | 100 | 03/29/2025 |
| 8.9.1 | 127 | 04/01/2025 |
| 8.9.0 | 124 | 04/01/2025 |
| 8.8.0 | 110 | 04/01/2025 |
| 8.7.0 | 127 | 04/01/2025 |
| 8.6.0 | 114 | 04/01/2025 |
| 8.5.0 | 127 | 04/01/2025 |
| 8.4.0 | 131 | 04/01/2025 |
| 8.3.0 | 114 | 04/01/2025 |
| 8.2.0 | 150 | 04/01/2025 |
| 8.1.0 | 121 | 04/01/2025 |
| 8.0.0 | 123 | 04/01/2025 |
| 8.0.0-rc.2.23510.2 | 123 | 04/01/2025 |
| 8.0.0-rc.1.23453.1 | 111 | 04/01/2025 |
| 8.0.0-preview.7.23407.5 | 99 | 04/01/2025 |
| 8.0.0-preview.6.23360.2 | 128 | 04/01/2025 |
| 8.0.0-preview.5.23308.3 | 121 | 04/01/2025 |
| 8.0.0-preview.4.23273.7 | 104 | 04/01/2025 |