Share via

CounterAttribute Class

Definition

Namespace:
Microsoft.Extensions.Diagnostics.Metrics
Assembly:
Microsoft.Extensions.Telemetry.Abstractions.dll
Package:
Microsoft.Extensions.Telemetry.Abstractions v9.10.0
Source:
CounterAttribute.cs
Source:
CounterAttribute.cs

Provides information to guide the production of a strongly typed 64 bit integer counter metric factory method and associated type.

public ref class CounterAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method)]
[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]
public sealed class CounterAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Method)>]
[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]
type CounterAttribute = class
    inherit Attribute
Public NotInheritable Class CounterAttribute
Inherits Attribute
Inheritance
Object
Attribute
CounterAttribute
Attributes
AttributeUsageAttribute ConditionalAttribute

Examples

static partial class Metric
{
    [Counter("RequestName", "RequestStatusCode")]
    static partial RequestCounter CreateRequestCounter(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 staticTagNames as string type parameters.

Constructors

CounterAttribute(String[])

Initializes a new instance of the CounterAttribute class.
CounterAttribute(Type)

Initializes a new instance of the CounterAttribute 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 tags values.

Applies to