Interface IWorkflowForgeLogger

Namespace

WorkflowForge.Abstractions

Assembly

WorkflowForge.dll

Interface for logging in WorkflowForge with structured logging support.

public interface IWorkflowForgeLogger

Extension Methods

WorkflowForgeLoggerExtensions.CreateCompensationResultProperties(IWorkflowForgeLogger, int, int)

WorkflowForgeLoggerExtensions.CreateCompensationScope(IWorkflowForgeLogger, int)

WorkflowForgeLoggerExtensions.CreateErrorProperties(IWorkflowForgeLogger, Exception, string?)

WorkflowForgeLoggerExtensions.CreateOperationScope(IWorkflowForgeLogger, IWorkflowOperation, int, object?)

WorkflowForgeLoggerExtensions.CreateWorkflowScope(IWorkflowForgeLogger, IWorkflow, IWorkflowFoundry)

Methods

BeginScope<TState>(TState, IDictionary<string, string>?)

Begins a scope with both a state and custom properties from a dictionary.

IDisposable BeginScope<TState>(TState state, IDictionary<string, string>? properties = null)

Parameters

state TState

The state object.

properties IDictionary<string, string>

Dictionary of custom properties.

Returns

IDisposable

IDisposable scope.

Type Parameters

TState

The type of the state object.

IsEnabled(WorkflowForgeLogLevel)

Returns whether the given log level is enabled for this logger. Call before allocating message payloads for disabled levels.

bool IsEnabled(WorkflowForgeLogLevel level)

Parameters

level WorkflowForgeLogLevel

The log level to check.

Returns

bool

true when messages at level would be emitted.

LogCritical(IDictionary<string, string>, Exception, string, params object[])

Log a message with exception and log level as critical.

void LogCritical(IDictionary<string, string> properties, Exception exception, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogCritical(IDictionary<string, string>, string, params object[])

Log a message with log level as critical and custom properties.

void LogCritical(IDictionary<string, string> properties, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogCritical(Exception, string, params object[])

Log a message with exception and log level as critical.

void LogCritical(Exception exception, string message, params object[] args)

Parameters

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogCritical(string, params object[])

Log a message with log level as critical.

void LogCritical(string message, params object[] args)

Parameters

message string

The message to log.

args object[]

Additional arguments for the message.

LogDebug(IDictionary<string, string>, Exception, string, params object[])

Log a message with exception and log level as debug.

void LogDebug(IDictionary<string, string> properties, Exception exception, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogDebug(IDictionary<string, string>, string, params object[])

Log a message with log level as debug and custom properties.

void LogDebug(IDictionary<string, string> properties, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogDebug(Exception, string, params object[])

Log a message with exception and log level as debug.

void LogDebug(Exception exception, string message, params object[] args)

Parameters

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogDebug(string, params object[])

Log a message with log level as debug.

void LogDebug(string message, params object[] args)

Parameters

message string

The message to log.

args object[]

Additional arguments for the message.

LogError(IDictionary<string, string>, Exception, string, params object[])

Log a message with exception and log level as error.

void LogError(IDictionary<string, string> properties, Exception exception, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogError(IDictionary<string, string>, string, params object[])

Log a message with log level as error and custom properties.

void LogError(IDictionary<string, string> properties, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogError(Exception, string, params object[])

Log a message with exception and log level as error.

void LogError(Exception exception, string message, params object[] args)

Parameters

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogError(string, params object[])

Log a message with log level as error.

void LogError(string message, params object[] args)

Parameters

message string

The message to log.

args object[]

Additional arguments for the message.

LogInformation(IDictionary<string, string>, Exception, string, params object[])

Log a message with exception and log level as information.

void LogInformation(IDictionary<string, string> properties, Exception exception, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogInformation(IDictionary<string, string>, string, params object[])

Log a message with log level as information and custom properties.

void LogInformation(IDictionary<string, string> properties, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogInformation(Exception, string, params object[])

Log a message with exception and log level as information.

void LogInformation(Exception exception, string message, params object[] args)

Parameters

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogInformation(string, params object[])

Log a message with log level as information.

void LogInformation(string message, params object[] args)

Parameters

message string

The message to log.

args object[]

Additional arguments for the message.

LogTrace(IDictionary<string, string>, Exception, string, params object[])

Log a message with exception and log level as trace.

void LogTrace(IDictionary<string, string> properties, Exception exception, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogTrace(IDictionary<string, string>, string, params object[])

Log a message with log level as trace and custom properties.

void LogTrace(IDictionary<string, string> properties, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogTrace(Exception, string, params object[])

Log a message with exception and log level as trace.

void LogTrace(Exception exception, string message, params object[] args)

Parameters

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogTrace(string, params object[])

Log a message with log level as trace.

void LogTrace(string message, params object[] args)

Parameters

message string

The message to log.

args object[]

Additional arguments for the message.

LogWarning(IDictionary<string, string>, Exception, string, params object[])

Log a message with exception and log level as warning.

void LogWarning(IDictionary<string, string> properties, Exception exception, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogWarning(IDictionary<string, string>, string, params object[])

Log a message with log level as warning and custom properties.

void LogWarning(IDictionary<string, string> properties, string message, params object[] args)

Parameters

properties IDictionary<string, string>

Custom properties for the log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogWarning(Exception, string, params object[])

Log a message with exception and log level as warning.

void LogWarning(Exception exception, string message, params object[] args)

Parameters

exception Exception

The exception to log.

message string

The message to log.

args object[]

Additional arguments for the message.

LogWarning(string, params object[])

Log a message with log level as warning.

void LogWarning(string message, params object[] args)

Parameters

message string

The message to log.

args object[]

Additional arguments for the message.