Hermod.Core.Logger Class Reference

Custom logger class for Hermod; internally uses Serilog. More...

Public Member Functions
	Logger ()
	Logger (bool enableConsole, bool enableDebug, bool enableFile)
ILogger	GetLogger ()
	Gets the instance of the Serilog logger.

Protected Member Functions
ILogger	CreateLogger ()
	Creates a new instance of the Serilog logger.

Properties
bool	EnableConsoleOutput = false [get, set]
	Gets or sets a value indicating whether or not to enable console logging.
bool	EnableDebugOutput = false [get, set]
bool	EnableFileOutput = true [get, set]
LogEventLevel	ConsoleLogLevel = LogEventLevel.Debug [get, set]
LogEventLevel	FileLogLevel = LogEventLevel.Information [get, set]
FileInfo?	LogFilePath = null [get, set]
long	MaxLogFileSize = (long)Math.Pow(1024, 3) * 5 [get, set]
RollingInterval	FileRollingInterval = RollingInterval.Day [get, set]
bool	RollOnFileSizeLimit = true [get, set]

Private Attributes
ILogger?	m_logger

Detailed Description

Custom logger class for Hermod; internally uses Serilog.

Definition at line 12 of file Logger.cs.

Constructor & Destructor Documentation

Logger() [1/2]

Hermod.Core.Logger.Logger ( )

inline

Definition at line 45 of file Logger.cs.

{ }

Referenced by Hermod.Program.InitialiseLogger().

Logger() [2/2]

Hermod.Core.Logger.Logger ( bool  enableConsole, bool  enableDebug, bool  enableFile  )

inline

Definition at line 47 of file Logger.cs.

                                                                             {
            EnableConsoleOutput = enableConsole;
            EnableDebugOutput = enableDebug;
            EnableFileOutput = enableFile;
        }

References Hermod.Core.Logger.EnableConsoleOutput, Hermod.Core.Logger.EnableDebugOutput, and Hermod.Core.Logger.EnableFileOutput.

Member Function Documentation

CreateLogger()

ILogger Hermod.Core.Logger.CreateLogger ( )

inlineprotected

Creates a new instance of the Serilog logger.

Definition at line 56 of file Logger.cs.

                                         {
            var logCfg = new LoggerConfiguration();
            if (EnableConsoleOutput) {
                logCfg.WriteTo.Console(ConsoleLogLevel, applyThemeToRedirectedOutput: true);
            }
            if (EnableDebugOutput) {
                logCfg.WriteTo.Debug(LogEventLevel.Debug);
            }
            if (EnableFileOutput && LogFilePath != null) {
                logCfg.WriteTo.File(
                    new JsonFormatter(),
                    LogFilePath.FullName,
                    FileLogLevel,
                    MaxLogFileSize,
                    rollingInterval: FileRollingInterval,
                    rollOnFileSizeLimit: RollOnFileSizeLimit,
                    shared: true
 
                );
            }
 
            m_logger = logCfg.CreateLogger();
            return m_logger;
        }

References Hermod.Core.Logger.ConsoleLogLevel, Hermod.Core.Logger.EnableConsoleOutput, Hermod.Core.Logger.EnableDebugOutput, Hermod.Core.Logger.EnableFileOutput, Hermod.Core.Logger.FileLogLevel, Hermod.Core.Logger.FileRollingInterval, Hermod.Core.Logger.LogFilePath, Hermod.Core.Logger.m_logger, Hermod.Core.Logger.MaxLogFileSize, and Hermod.Core.Logger.RollOnFileSizeLimit.

GetLogger()

ILogger Hermod.Core.Logger.GetLogger

(

)

Gets the instance of the Serilog logger.

Returns

An instance of ILogger

Referenced by Hermod.Program.InitialiseLogger().

Member Data Documentation

m_logger

ILogger? Hermod.Core.Logger.m_logger

private

Definition at line 43 of file Logger.cs.

Referenced by Hermod.Core.Logger.CreateLogger().

Property Documentation

ConsoleLogLevel

LogEventLevel Hermod.Core.Logger.ConsoleLogLevel = LogEventLevel.Debug

getset

Definition at line 30 of file Logger.cs.

{ get; set; } = LogEventLevel.Debug;

Referenced by Hermod.Core.Logger.CreateLogger().

EnableConsoleOutput

bool Hermod.Core.Logger.EnableConsoleOutput = false

getset

Gets or sets a value indicating whether or not to enable console logging.

Definition at line 17 of file Logger.cs.

{ get; set; } = false;

Referenced by Hermod.Core.Logger.CreateLogger(), and Hermod.Core.Logger.Logger().

EnableDebugOutput

bool Hermod.Core.Logger.EnableDebugOutput = false

getsetprivate

Definition at line 22 of file Logger.cs.

{ get; set; } = false;

Referenced by Hermod.Core.Logger.CreateLogger(), and Hermod.Core.Logger.Logger().

EnableFileOutput

bool Hermod.Core.Logger.EnableFileOutput = true

getset

Definition at line 25 of file Logger.cs.

{ get; set; } = true;

Referenced by Hermod.Core.Logger.CreateLogger(), and Hermod.Core.Logger.Logger().

FileLogLevel

LogEventLevel Hermod.Core.Logger.FileLogLevel = LogEventLevel.Information

getset

Definition at line 33 of file Logger.cs.

{ get; set; } = LogEventLevel.Information;

Referenced by Hermod.Core.Logger.CreateLogger().

FileRollingInterval

RollingInterval Hermod.Core.Logger.FileRollingInterval = RollingInterval.Day

getset

Definition at line 39 of file Logger.cs.

{ get; set; } = RollingInterval.Day;

Referenced by Hermod.Core.Logger.CreateLogger().

LogFilePath

FileInfo? Hermod.Core.Logger.LogFilePath = null

getset

Definition at line 35 of file Logger.cs.

{ get; set; } = null;

Referenced by Hermod.Core.Logger.CreateLogger().

MaxLogFileSize

long Hermod.Core.Logger.MaxLogFileSize = (long)Math.Pow(1024, 3) * 5

getset

Definition at line 37 of file Logger.cs.

{ get; set; } = (long)Math.Pow(1024, 3) * 5; // default is 5MiB

Referenced by Hermod.Core.Logger.CreateLogger().

RollOnFileSizeLimit

bool Hermod.Core.Logger.RollOnFileSizeLimit = true

getset

Definition at line 41 of file Logger.cs.

{ get; set; } = true;

Referenced by Hermod.Core.Logger.CreateLogger().

---

The documentation for this class was generated from the following file:

• Logger.cs