Class Factory

Namespace

TCSystem.Logging

Assembly

TCSystem.Logging.dll

Creates loggers and manages the process-wide Serilog configuration.

public static class Factory

Inheritance

object

Factory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

DeInitLogging()

Releases one logging initialization reference and flushes all sinks when the final reference is released.

public static void DeInitLogging()

GetLogger(Type)

Creates a logger whose source context is the supplied type.

public static Logger GetLogger(Type type)

Parameters

type Type

The type used as the source context.

Returns

Logger

A logger for type.

InitLogging(LoggingOptions, Action<LoggerConfiguration>)

Initializes process-wide logging without a file path.

public static bool InitLogging(Factory.LoggingOptions options, Action<LoggerConfiguration> configure = null)

Parameters

options Factory.LoggingOptions

The default sinks to enable.

configure Action<LoggerConfiguration>

An optional callback that can extend the Serilog configuration.

Returns

bool

true when initialization succeeds.

Remarks

Initialization is reference-counted; balance each call with DeInitLogging().

InitLogging(LoggingOptions, string, int, int, Action<LoggerConfiguration>)

Initializes process-wide logging with rolling-file settings.

public static bool InitLogging(Factory.LoggingOptions options, string loggingFile, int maxFiles = 2, int maxFileSizeKb = 1024, Action<LoggerConfiguration> configure = null)

Parameters

options Factory.LoggingOptions

The default sinks to enable.

loggingFile string

The output path used when File is enabled.

maxFiles int

The maximum number of retained rolling files.

maxFileSizeKb int

The size limit of each file in kilobytes.

configure Action<LoggerConfiguration>

An optional callback that can extend the Serilog configuration.

Returns

bool

true when initialization succeeds.

Remarks

Initialization is reference-counted; balance each call with DeInitLogging().