TagNameAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.Logging

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

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

Source:: TagNameAttribute.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.

Defines the tag name to use for a logged parameter or property.

public ref class TagNameAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property)]
[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]
public sealed class TagNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property)>]
[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]
type TagNameAttribute = class
    inherit Attribute

Public NotInheritable Class TagNameAttribute
Inherits Attribute

Inheritance: Object

Attribute
TagNameAttribute

Attributes: AttributeUsageAttribute ConditionalAttribute

Examples

[LoggerMessage(1, LogLevel.Information, "My custom tag name: {my.custom.tagname}")]
public static partial void LogMyCustomTagName(
    this ILogger logger,
    [TagName("my.custom.tagname")] string name);

Remarks

By default, the tag name is the same as the respective parameter 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 to be used when logging the parameter or property.

Applies to

Поделиться через