Class MessageProcessingLogger

Namespace

Steeltoe.Extensions.Logging

Assembly

Steeltoe.Extensions.Logging.Abstractions.dll

public class MessageProcessingLogger : ILogger

Inheritance

object

MessageProcessingLogger

Implements

ILogger

Derived

StructuredMessageProcessingLogger

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MessageProcessingLogger(ILogger, IEnumerable<IDynamicMessageProcessor>)

Initializes a new instance of the MessageProcessingLogger class. Wraps an ILogger and decorates log messages via IDynamicMessageProcessor

public MessageProcessingLogger(ILogger iLogger, IEnumerable<IDynamicMessageProcessor> messageProcessors = null)

Parameters

iLogger ILogger

The ILogger being wrapped

messageProcessors IEnumerable<IDynamicMessageProcessor>

The list of IDynamicMessageProcessors

Properties

Delegate

public ILogger Delegate { get; }

Property Value

ILogger

Filter

public Func<string, LogLevel, bool> Filter { get; }

Property Value

Func<string, LogLevel, bool>

Name

public string Name { get; }

Property Value

string

Methods

BeginScope<TState>(TState)

Begins a logical operation scope.

public IDisposable BeginScope<TState>(TState state)

Parameters

state TState

The identifier for the scope.

Returns

IDisposable

An IDisposable that ends the logical operation scope on dispose.

Type Parameters

TState

The type of the state to begin scope for.

IsEnabled(LogLevel)

Checks if the given logLevel is enabled.

public bool IsEnabled(LogLevel logLevel)

Parameters

logLevel LogLevel

level to be checked.

Returns

bool

true if enabled.

Log<TState>(LogLevel, EventId, TState, Exception, Func<TState, Exception, string>)

Writes a log entry.

public virtual void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)

Parameters

logLevel LogLevel

Entry will be written on this level.

eventId EventId

Id of the event.

state TState

The entry to be written. Can be also an object.

exception Exception

The exception related to this entry.

formatter Func<TState, Exception, string>

Function to create a string message of the state and exception.

Type Parameters

TState

The type of the object to be written.

WriteMessage(LogLevel, string, int, string, Exception)

public virtual void WriteMessage(LogLevel logLevel, string logName, int eventId, string message, Exception exception)

Parameters

logLevel LogLevel

logName string

eventId int

message string

exception Exception