Class ILoggerExtensions

Namespace

Songhay.Extensions

Assembly

SonghayCore.dll

Extensions of ILogger to assist with “structured logging.”

public static class ILoggerExtensions

Inheritance

object

ILoggerExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

For a video overview of “structured logging,” see https://www.youtube.com/watch?v=NlBjVJPkT6M 🎥

To prevent passing null instances of ILogger into these methods, use AsInstanceOrNullLogger(ILogger?).

Methods

LogErrorForMissingData(ILogger, string)

Calls LogError(ILogger, string, params object[]) for missing data.

public static void LogErrorForMissingData(this ILogger logger, string caption)

Parameters

logger ILogger

The logger.

caption string

The caption.

LogErrorForMissingData<TData>(ILogger)

Calls LogError(ILogger, string, params object[]) for missing data.

public static void LogErrorForMissingData<TData>(this ILogger logger)

Parameters

logger ILogger

The logger.

Type Parameters

TData

The type of the data.

LogInformationNewLine(ILogger)

Calls LogNewLine(ILogger, LogLevel) for Information.

public static void LogInformationNewLine(this ILogger logger)

Parameters

logger ILogger

The logger.

LogNewLine(ILogger, LogLevel)

Logs NewLine for human readability.

public static void LogNewLine(this ILogger logger, LogLevel level)

Parameters

logger ILogger

The logger.

level LogLevel

The level.

LogTraceDataTypeAndValue<TData>(ILogger, TData?)

Traces data type and value.

public static void LogTraceDataTypeAndValue<TData>(this ILogger logger, TData? data)

Parameters

logger ILogger

The logger.

data TData

The data.

Type Parameters

TData

The type of the data.

Remarks

For the best results, ensure that the ToString() method is properly overridden.

LogTraceMethodCall(ILogger, string?)

Conventional trace of the specified method call.

public static void LogTraceMethodCall(this ILogger logger, string? methodName)

Parameters

logger ILogger

The logger.

methodName string

Name of the method.

LogTraceNewLine(ILogger)

Calls LogNewLine(ILogger, LogLevel) for Trace.

public static void LogTraceNewLine(this ILogger logger)

Parameters

logger ILogger

The logger.