ExceptionSummary Struct

Definition

Namespace:

Microsoft.Extensions.Diagnostics.ExceptionSummarization

Assembly:

Microsoft.Extensions.Diagnostics.ExceptionSummarization.dll

Package:

Microsoft.Extensions.Diagnostics.ExceptionSummarization v9.2.0

Holds a summary of an exception for use in telemetry.

C#

public readonly struct ExceptionSummary : IEquatable<Microsoft.Extensions.Diagnostics.ExceptionSummarization.ExceptionSummary>

Inheritance

Object

ValueType

ExceptionSummary

Implements

IEquatable<ExceptionSummary>

Remarks

Metric tags typically support a limited number of distinct values, and as such they are not suitable to represent values that are highly variable, such as the result of ToString(). An exception summary represents a low-cardinality version of an exception's information, suitable for such cases.

The Description property never includes sensitive information. But the AdditionalDetails property might contain sensitive information and thus shouldn't be used in telemetry.

Constructors

ExceptionSummary(String, String, String)

Initializes a new instance of the ExceptionSummary struct.

Properties

AdditionalDetails	Gets the additional details of the exception.
Description	Gets the summary description of the exception.
ExceptionType	Gets the type description of the exception.

Methods

Equals(ExceptionSummary)	Determines whether this summary and a specified other summary are identical.
Equals(Object)	Determines whether this summary and a specified other summary are identical.
GetHashCode()	Gets a hash code for this object.
ToString()	Gets a string representation of this object.

Operators

Equality(ExceptionSummary, ExceptionSummary)	Equality operator.
Inequality(ExceptionSummary, ExceptionSummary)	Inequality operator.

Applies to