GaugeAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.Diagnostics.Metrics

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

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

Source:: GaugeAttribute.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 gauge metric factory method and associated type.

public ref class GaugeAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Method)>]
[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]
type GaugeAttribute = class
    inherit Attribute

Public NotInheritable Class GaugeAttribute
Inherits Attribute

Inheritance: Object

Attribute
GaugeAttribute

Attributes: AttributeUsageAttribute ConditionalAttribute

Examples

static partial class Metric
{
    [Gauge]
    static partial MemoryUsage CreateMemoryUsage(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

GaugeAttribute(String[])	Initializes a new instance of the GaugeAttribute class.
GaugeAttribute(Type)	Initializes a new instance of the GaugeAttribute 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.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Partilhar via