Class WrappingStringLogger

Namespace

The.Utility

Assembly

Instagile.dll

This ILogger implementation wraps around an existing instance and captures log messages.

public sealed class WrappingStringLogger : ILogger

Inheritance

object

WrappingStringLogger

Implements

ILogger

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

SurfaceExtensions.LogNotification(ILogger, string, MessageLevel, string)

Constructors

WrappingStringLogger(ILogger, LogLevel)

public WrappingStringLogger(ILogger inner, LogLevel minimumLogLevel = LogLevel.Information)

Parameters

inner ILogger

The ILogger to wrap around.

minimumLogLevel LogLevel

The minimum LogLevel to wrap around.

Methods

BeginScope<TState>(TState)

Begins a logical operation scope.

public IDisposable? BeginScope<TState>(TState state) where TState : notnull

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.

GetLogs()

Retrieves the captured log messages

public string GetLogs()

Returns

string

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 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.