Class EventDefinition

Namespace

Microsoft.EntityFrameworkCore.Diagnostics

Assembly

Microsoft.EntityFrameworkCore.dll

Defines metadata for an event with no parameters and a cached delegate to log the event with reduced allocations.

public class EventDefinition : EventDefinitionBase

Inheritance

object

EventDefinitionBase

EventDefinition

Inherited Members

EventDefinitionBase.WarningAsError(string)

EventDefinitionBase.EventId

EventDefinitionBase.Level

EventDefinitionBase.EventIdCode

EventDefinitionBase.WarningBehavior

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

See Implementation of database providers and extensions for more information and examples.

Constructors

EventDefinition(ILoggingOptions, EventId, LogLevel, string, Func<LogLevel, Action<ILogger, Exception?>>)

Creates an event definition instance.

public EventDefinition(ILoggingOptions loggingOptions, EventId eventId, LogLevel level, string eventIdCode, Func<LogLevel, Action<ILogger, Exception?>> logActionFunc)

Parameters

loggingOptions ILoggingOptions

Logging options.

eventId EventId

The EventId.

level LogLevel

The LogLevel at which the event will be logged.

eventIdCode string

A string representing the code that should be passed to ConfigureWarnings(Action<WarningsConfigurationBuilder>).

logActionFunc Func<LogLevel, Action<ILogger, Exception>>

Function to create a cached delegate for logging the event.

Methods

GenerateMessage()

Generates the message that would be logged without logging it. Typically used for throwing an exception in warning-as-error cases.

public virtual string GenerateMessage()

Returns

string

The message string.

Log<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory>, Exception?)

Logs the event, or throws if the event has been configured to be treated as an error.

public virtual void Log<TLoggerCategory>(IDiagnosticsLogger<TLoggerCategory> logger, Exception? exception = null) where TLoggerCategory : LoggerCategory<TLoggerCategory>, new()

Parameters

logger IDiagnosticsLogger<TLoggerCategory>

The logger to which the event should be logged.

exception Exception

Optional exception associated with the event.

Type Parameters

TLoggerCategory

The DbLoggerCategory.