LoggerMessageAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.Logging

Assembly:: Microsoft.Extensions.Logging.Abstractions.dll

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

Source:: LoggerMessageAttribute.cs

Source:: LoggerMessageAttribute.cs

Source:: LoggerMessageAttribute.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 logging method.

public ref class LoggerMessageAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class LoggerMessageAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type LoggerMessageAttribute = class
    inherit Attribute

Public NotInheritable Class LoggerMessageAttribute
Inherits Attribute

Inheritance: Object

Attribute
LoggerMessageAttribute

Attributes: AttributeUsageAttribute

Examples

static partial class Log
{
    [LoggerMessage(EventId = 0, Message = "Could not open socket for {hostName}")]
    static partial void CouldNotOpenSocket(ILogger logger, LogLevel level, string hostName);
}

Remarks

The method this attribute is applied to:

- Must be a partial method.

- Must return void.

- Must not be generic.

- Must have an ILogger as one of its parameters.

- Must have a LogLevel as one of its parameters.

- None of the parameters can be generic.

Constructors

LoggerMessageAttribute()	Initializes a new instance of the LoggerMessageAttribute class that's used to guide the production of a strongly typed logging method.
LoggerMessageAttribute(Int32, LogLevel, String)	Initializes a new instance of the LoggerMessageAttribute class that's used to guide the production of a strongly typed logging method.
LoggerMessageAttribute(LogLevel, String)	Initializes a new instance of the LoggerMessageAttribute class that's used to guide the production of a strongly typed logging method.
LoggerMessageAttribute(LogLevel)	Initializes a new instance of the LoggerMessageAttribute class that's used to guide the production of a strongly typed logging method.
LoggerMessageAttribute(String)	Initializes a new instance of the LoggerMessageAttribute class that's used to guide the production of a strongly typed logging method.

Properties

EventId	Gets or sets the logging event ID for the logging method.
EventName	Gets or sets the logging event name for the logging method.
Level	Gets or sets the logging level for the logging method.
Message	Gets or sets the message text for the logging method.
SkipEnabledCheck	Gets or sets the flag to skip IsEnabled check for the logging method.
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

Share via