Interface IALogService

The interface for an actionETL logging service. This, and IALogFactory, must be implemented to inject a custom logging framework into a worker system. Otherwise not used directly by the library user.

Namespace: actionETL.Logging

Assembly: actionETL.dll

Syntax

public interface IALogService

Properties

IsDebugEnabled

Gets a value indicating whether logging is enabled for the Debug level.

This property must be thread-safe.

Declaration

bool IsDebugEnabled { get; }

Property Value

Type	Description
Boolean	true if logging is enabled for the Debug level, otherwise false.

IsErrorEnabled

Gets a value indicating whether logging is enabled for the Error level.

This property must be thread-safe.

Declaration

bool IsErrorEnabled { get; }

Property Value

Type	Description
Boolean	true if logging is enabled for the Error level, otherwise false.

IsFatalEnabled

Gets a value indicating whether logging is enabled for the Fatal level.

This property must be thread-safe.

Declaration

bool IsFatalEnabled { get; }

Property Value

Type	Description
Boolean	true if logging is enabled for the Fatal level, otherwise false.

IsInfoEnabled

Gets a value indicating whether logging is enabled for the Info level.

This property must be thread-safe.

Declaration

bool IsInfoEnabled { get; }

Property Value

Type	Description
Boolean	true if logging is enabled for the Info level, otherwise false.

IsTraceEnabled

Gets a value indicating whether logging is enabled for the Trace level.

This property must be thread-safe.

Declaration

bool IsTraceEnabled { get; }

Property Value

Type	Description
Boolean	true if logging is enabled for the Trace level, otherwise false.

IsWarnEnabled

Gets a value indicating whether logging is enabled for the Warn level.

This property must be thread-safe.

Declaration

bool IsWarnEnabled { get; }

Property Value

Type	Description
Boolean	true if logging is enabled for the Warn level, otherwise false.

Name

Gets the name of the logger.

This property must be thread-safe.

Declaration

string Name { get; }

Property Value

Type	Description
String

Methods

IsEnabled(ALogLevel)

Gets a value indicating whether logging is enabled for the specified level.

This method must be thread-safe.

Declaration

bool IsEnabled(ALogLevel logLevel)

Parameters

Type	Name	Description
ALogLevel	logLevel	The log level to check.

Returns

Type	Description
Boolean	true if the specified log level is enabled; otherwise false.

Log(ALogLevel, String, Exception, String)

Logs a log event, with a message string.

This method must be thread-safe.

Declaration

void Log(ALogLevel logLevel, string category, Exception exception, string message)

Parameters

Type	Name	Description
ALogLevel	logLevel	The log level.
String	category	The category, can be null (although it is advisable to populate this parameter.)
Exception	exception	The exception, can be null.
String	message	The message, can be null.

Log(ALogMessageCallback, ALogLevel, String, Exception)

Logs a log event, with a message callback.

This method must be thread-safe.

Declaration

void Log(ALogMessageCallback messageFunc, ALogLevel logLevel, string category, Exception exception)

Parameters

Type	Name	Description
ALogMessageCallback	messageFunc	The message function returning a string. It can be null, as can the returned string, in which case no custom message will be added to the logged event.
ALogLevel	logLevel	The log level.
String	category	The category, can be null (although it is advisable to populate this parameter.)
Exception	exception	The exception, can be null.