HistogramAttribute<T> Class

Reference

Definition

Namespace:: Microsoft.Extensions.Diagnostics.Metrics

Assembly:: Microsoft.Extensions.Telemetry.Abstractions.dll

Package:: Microsoft.Extensions.Telemetry.Abstractions v9.1.0

Source:: HistogramAttributeT.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

generic <typename T>
 where T : value classpublic ref class HistogramAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method)]
[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]
public sealed class HistogramAttribute<T> : Attribute where T : struct

[<System.AttributeUsage(System.AttributeTargets.Method)>]
[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]
type HistogramAttribute<'T (requires 'T : struct)> = class
    inherit Attribute

Public NotInheritable Class HistogramAttribute(Of T)
Inherits Attribute

Type Parameters

T

The type of value the histogram will hold, which is limited to Byte, Int16, Int32, Int64, Single, Double, or Decimal.

Inheritance: Object

Attribute
HistogramAttribute<T>

Attributes: AttributeUsageAttribute ConditionalAttribute

Examples

static partial class Metric
{
    [Histogram<int>("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<T>(String[])	Initializes a new instance of the HistogramAttribute<T> class.
HistogramAttribute<T>(Type)	Initializes a new instance of the HistogramAttribute<T> class.

Properties

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

Applies to

Share via