TagNameAttribute Class

Definition

Namespace:

Microsoft.Extensions.Diagnostics.Metrics

Assembly:

Microsoft.Extensions.Telemetry.Abstractions.dll

Package:

Microsoft.Extensions.Telemetry.Abstractions v9.0.0-preview.3.24209.3

Source:

TagNameAttribute.cs

Provides tag information for strongly typed metrics.

public ref class TagNameAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)]
public sealed class TagNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)>]
type TagNameAttribute = class
    inherit Attribute

Public NotInheritable Class TagNameAttribute
Inherits Attribute

Inheritance

Object

Attribute

TagNameAttribute

Attributes

AttributeUsageAttribute

Examples

public class MyStrongTypeMetric
{
    [TagName("tag_name_as_per_some_convention1")]
    public string Name1 { get; set; }

    [TagName("tag_name_as_per_some_convention2")]
    public string Name2;
}

Remarks

This attribute is applied to fields or properties of a metric class to override default tag names. By default, the tag name is the same as the respective field or property. You can use this attribute to override the default and provide a custom tag name.

Constructors

TagNameAttribute(String)

Initializes a new instance of the TagNameAttribute class.

Properties

Name	Gets the name of the tag.
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)