Class Logger

Namespace

Stride.Core.Diagnostics

Assembly

Stride.Core.dll

Base implementation for ILogger.

public abstract class Logger : ILogger

Inheritance

object

Logger

Implements

ILogger

Derived

GlobalLogger

LoggerResult

TimestampLocalLogger

Extension Methods

LoggerExtensions.Debug(ILogger, string, CallerInfo?)

LoggerExtensions.Debug(ILogger, string, Exception?, CallerInfo?)

LoggerExtensions.Error(ILogger, string, CallerInfo?)

LoggerExtensions.Error(ILogger, string, Exception?, CallerInfo?)

LoggerExtensions.Fatal(ILogger, string, CallerInfo?)

LoggerExtensions.Fatal(ILogger, string, Exception?, CallerInfo?)

LoggerExtensions.Info(ILogger, string, CallerInfo?)

LoggerExtensions.Info(ILogger, string, Exception?, CallerInfo?)

LoggerExtensions.Verbose(ILogger, string, CallerInfo?)

LoggerExtensions.Verbose(ILogger, string, Exception?, CallerInfo?)

LoggerExtensions.Warning(ILogger, string, CallerInfo?)

LoggerExtensions.Warning(ILogger, string, Exception?, CallerInfo?)

Constructors

Logger()

Initializes a new instance of the Logger class.

protected Logger()

Fields

EnableTypes

protected readonly bool[] EnableTypes

Field Value

bool[]

IsDebugEnabled

True if the debug level is enabled at a global level

public static readonly bool IsDebugEnabled

Field Value

bool

IsVerboseEnabled

True if the verbose level is enabled at a global level

public static readonly bool IsVerboseEnabled

Field Value

bool

Properties

HasErrors

Gets or sets a value indicating whether this instance has errors.

public bool HasErrors { get; set; }

Property Value

bool

true if this instance has errors; otherwise, false.

MinimumLevelEnabled

Gets the minimum level enabled from the config file. Can be overridden by the user.

public static LogMessageType MinimumLevelEnabled { get; set; }

Property Value

LogMessageType

Module

Gets the module name. read-only.

public string? Module { get; protected set; }

Property Value

string

The module name.

Methods

ActivateLog(LogMessageType, LogMessageType, bool)

Activates the log for this logger for a range of LogMessageType.

public void ActivateLog(LogMessageType fromLevel, LogMessageType toLevel = LogMessageType.Fatal, bool enabledFlag = true)

Parameters

fromLevel LogMessageType

The lowest inclusive level to log for.

toLevel LogMessageType

The highest inclusive level to log for.

enabledFlag bool

if set to true this will enable the log, false otherwise. Default is true.

Remarks

Outside the specified range the log message type are disabled (!enabledFlag).

ActivateLog(LogMessageType, bool)

Activates the log for this logger for a specific LogMessageType.

public void ActivateLog(LogMessageType type, bool enabledFlag)

Parameters

type LogMessageType

The type.

enabledFlag bool

if set to true [enabled flag].

Remarks

All other activated type are leaved intact.

Activated(LogMessageType)

Returns a boolean indicating if a particular LogMessageType is activated.

public bool Activated(LogMessageType type)

Parameters

type LogMessageType

The type.

Returns

bool

True if the log is activated, otherwise false.

Debug(string, CallerInfo?)

Logs the specified debug message.

public void Debug(string message, CallerInfo? callerInfo = null)

Parameters

message string

The debug message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Debug(string, Exception?, CallerInfo?)

Logs the specified debug message with an exception.

public void Debug(string message, Exception? exception, CallerInfo? callerInfo = null)

Parameters

message string

The debug message.

exception Exception

An exception to log with the message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Error(string, CallerInfo?)

Logs the specified error message.

public void Error(string message, CallerInfo? callerInfo = null)

Parameters

message string

The error message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Error(string, Exception?, CallerInfo?)

Logs the specified error message with an exception.

public void Error(string message, Exception? exception, CallerInfo? callerInfo = null)

Parameters

message string

The error message.

exception Exception

An exception to log with the message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Fatal(string, CallerInfo?)

Logs the specified fatal message.

public void Fatal(string message, CallerInfo? callerInfo = null)

Parameters

message string

The fatal message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Fatal(string, Exception?, CallerInfo?)

Logs the specified fatal message with an exception.

public void Fatal(string message, Exception? exception, CallerInfo? callerInfo = null)

Parameters

message string

The fatal message.

exception Exception

An exception to log with the message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Info(string, CallerInfo?)

Logs the specified info message.

public void Info(string message, CallerInfo? callerInfo = null)

Parameters

message string

The info message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Info(string, Exception?, CallerInfo?)

Logs the specified info message with an exception.

public void Info(string message, Exception? exception, CallerInfo? callerInfo = null)

Parameters

message string

The info message.

exception Exception

An exception to log with the message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Log(ILogMessage)

Logs the specified log message.

public void Log(ILogMessage logMessage)

Parameters

logMessage ILogMessage

The log message.

LogRaw(ILogMessage)

Internal method used to log a message. All Info, Debug, Error...etc. methods are calling this method.

protected abstract void LogRaw(ILogMessage logMessage)

Parameters

logMessage ILogMessage

The log message.

Verbose(string, CallerInfo?)

Logs the specified verbose message.

public void Verbose(string message, CallerInfo? callerInfo = null)

Parameters

message string

The verbose message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Verbose(string, Exception?, CallerInfo?)

Logs the specified verbose message with an exception.

public void Verbose(string message, Exception? exception, CallerInfo? callerInfo = null)

Parameters

message string

The verbose message.

exception Exception

An exception to log with the message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Warning(string, CallerInfo?)

Logs the specified warning message.

public void Warning(string message, CallerInfo? callerInfo = null)

Parameters

message string

The warning message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Warning(string, Exception?, CallerInfo?)

Logs the specified warning message with an exception.

public void Warning(string message, Exception? exception, CallerInfo? callerInfo = null)

Parameters

message string

The warning message.

exception Exception

An exception to log with the message.

callerInfo CallerInfo

Information about the caller. Default is null, otherwise use Get(string, string, int).

Events

MessageLogged

Occurs when a message is logged.

public event EventHandler<MessageLoggedEventArgs>? MessageLogged

Event Type

EventHandler<MessageLoggedEventArgs>