HistogramAttribute Class

Definition

Namespace:

Microsoft.Extensions.Diagnostics.Metrics

Assembly:

Microsoft.Extensions.Telemetry.Abstractions.dll

Package:

Microsoft.Extensions.Telemetry.Abstractions v9.2.0

Provides information to guide the production of a strongly typed histogram metric factory method and associated type.

C#

[System.AttributeUsage(System.AttributeTargets.Method)]
[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]
public sealed class HistogramAttribute : Attribute

Inheritance

Object

Attribute

HistogramAttribute

Attributes

AttributeUsageAttribute ConditionalAttribute

Examples

C#

static partial class Metric
{
    [Histogram("RequestName", "RequestStatusCode")]
    static partial RequestLatency CreateRequestLatency(Meter meter);
}

Remarks

This attribute is applied to a method that has the following constraints:

• Must be a partial method.
• Must return metricName as the type. A class with that name will be generated.
• Must not be generic.
• Must have System.Diagnostics.Metrics.Meter as first parameter.
• Must have all the keys provided in staticTags as string type parameters.

Constructors

HistogramAttribute(String[])	Initializes a new instance of the HistogramAttribute class.
HistogramAttribute(Type)	Initializes a new instance of the HistogramAttribute class.

Properties

Name	Gets or sets the name of the metric.
TagNames	Gets the metric's tags.
Type	Gets the type that supplies metric tag values.

Applies to