Class Logger

Namespace

Serilog.Core

Assembly

Serilog.dll

The core Serilog logging pipeline. A Logger must be disposed to flush any events buffered within it. Most application code should depend on ILogger, not this class.

public sealed class Logger : ILogger, ILogEventSink, IDisposable, IAsyncDisposable

Inheritance

object

Logger

Implements

ILogger

ILogEventSink

IDisposable

IAsyncDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

LoggerExtensions.ForContext<TValue>(ILogger, LogEventLevel, string, TValue, bool)

Properties

None

An ILogger instance that efficiently ignores all method calls.

public static ILogger None { get; }

Property Value

ILogger

Methods

BindMessageTemplate(string, object?[]?, out MessageTemplate?, out IEnumerable<LogEventProperty>?)

Uses configured scalar conversion and destructuring rules to bind a set of properties to a message template. Returns false if the template or values are invalid (ILogger methods never throw exceptions).

[MessageTemplateFormatMethod("messageTemplate")]
public bool BindMessageTemplate(string messageTemplate, object?[]? propertyValues, out MessageTemplate? parsedTemplate, out IEnumerable<LogEventProperty>? boundProperties)

Parameters

messageTemplate string

Message template describing an event.

propertyValues object[]

Objects positionally formatted into the message template.

parsedTemplate MessageTemplate

The internal representation of the template, which may be used to render the boundProperties as text.

boundProperties IEnumerable<LogEventProperty>

Captured properties from the template and propertyValues.

Returns

bool

Examples

MessageTemplate template; IEnumerable<LogEventProperty> properties>; if (Log.BindMessageTemplate("Hello, {Name}!", new[] { "World" }, out template, out properties) { var propsByName = properties.ToDictionary(p => p.Name, p => p.Value); Console.WriteLine(template.Render(propsByName, null)); // -> "Hello, World!" }

BindProperty(string?, object?, bool, out LogEventProperty?)

Uses configured scalar conversion and destructuring rules to bind a property value to its captured representation.

public bool BindProperty(string? propertyName, object? value, bool destructureObjects, out LogEventProperty? property)

Parameters

propertyName string

The name of the property. Must be non-empty.

value object

The property value.

destructureObjects bool

If true, the value will be serialized as a structured object if possible; if false, the object will be recorded as a scalar or simple array.

property LogEventProperty

The resulting property.

Returns

bool

True if the property could be bound, otherwise false (

ILogger

methods never throw exceptions).

Debug(Exception?, string)

Write a log event with the Debug level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug(Exception? exception, string messageTemplate)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Examples

Log.Debug(ex, "Swallowing a mundane exception.");

Debug(Exception?, string, params object?[]?)

Write a log event with the Debug level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug(Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Debug(ex, "Swallowing a mundane exception.");

Debug(string)

Write a log event with the Debug level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug(string messageTemplate)

Parameters

messageTemplate string

Message template describing the event.

Examples

Log.Debug("Starting up at {StartedAt}.", DateTime.Now);

Debug(string, params object?[]?)

Write a log event with the Debug level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug(string messageTemplate, params object?[]? propertyValues)

Parameters

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Debug("Starting up at {StartedAt}.", DateTime.Now);

Debug<T>(Exception?, string, T)

Write a log event with the Debug level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug<T>(Exception? exception, string messageTemplate, T propertyValue)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Debug(ex, "Swallowing a mundane exception.");

Debug<T>(string, T)

Write a log event with the Debug level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug<T>(string messageTemplate, T propertyValue)

Parameters

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Debug("Starting up at {StartedAt}.", DateTime.Now);

Debug<T0, T1>(Exception?, string, T0, T1)

Write a log event with the Debug level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug<T0, T1>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Debug(ex, "Swallowing a mundane exception.");

Debug<T0, T1>(string, T0, T1)

Write a log event with the Debug level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug<T0, T1>(string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Debug("Starting up at {StartedAt}.", DateTime.Now);

Debug<T0, T1, T2>(Exception?, string, T0, T1, T2)

Write a log event with the Debug level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug<T0, T1, T2>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Debug(ex, "Swallowing a mundane exception.");

Debug<T0, T1, T2>(string, T0, T1, T2)

Write a log event with the Debug level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Debug<T0, T1, T2>(string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Debug("Starting up at {StartedAt}.", DateTime.Now);

Dispose()

Close and flush the logging pipeline.

public void Dispose()

DisposeAsync()

Close and flush the logging pipeline.

public ValueTask DisposeAsync()

Returns

ValueTask

Error(Exception?, string)

Write a log event with the Error level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error(Exception? exception, string messageTemplate)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Examples

Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length);

Error(Exception?, string, params object?[]?)

Write a log event with the Error level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error(Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length);

Error(string)

Write a log event with the Error level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error(string messageTemplate)

Parameters

messageTemplate string

Message template describing the event.

Examples

Log.Error("Failed {ErrorCount} records.", brokenRecords.Length);

Error(string, params object?[]?)

Write a log event with the Error level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error(string messageTemplate, params object?[]? propertyValues)

Parameters

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Error("Failed {ErrorCount} records.", brokenRecords.Length);

Error<T>(Exception?, string, T)

Write a log event with the Error level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error<T>(Exception? exception, string messageTemplate, T propertyValue)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length);

Error<T>(string, T)

Write a log event with the Error level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error<T>(string messageTemplate, T propertyValue)

Parameters

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Error("Failed {ErrorCount} records.", brokenRecords.Length);

Error<T0, T1>(Exception?, string, T0, T1)

Write a log event with the Error level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error<T0, T1>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length);

Error<T0, T1>(string, T0, T1)

Write a log event with the Error level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error<T0, T1>(string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Error("Failed {ErrorCount} records.", brokenRecords.Length);

Error<T0, T1, T2>(Exception?, string, T0, T1, T2)

Write a log event with the Error level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error<T0, T1, T2>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length);

Error<T0, T1, T2>(string, T0, T1, T2)

Write a log event with the Error level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Error<T0, T1, T2>(string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Error("Failed {ErrorCount} records.", brokenRecords.Length);

Fatal(Exception?, string)

Write a log event with the Fatal level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal(Exception? exception, string messageTemplate)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Examples

Log.Fatal(ex, "Process terminating.");

Fatal(Exception?, string, params object?[]?)

Write a log event with the Fatal level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal(Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Fatal(ex, "Process terminating.");

Fatal(string)

Write a log event with the Fatal level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal(string messageTemplate)

Parameters

messageTemplate string

Message template describing the event.

Examples

Log.Fatal("Process terminating.");

Fatal(string, params object?[]?)

Write a log event with the Fatal level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal(string messageTemplate, params object?[]? propertyValues)

Parameters

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Fatal("Process terminating.");

Fatal<T>(Exception?, string, T)

Write a log event with the Fatal level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal<T>(Exception? exception, string messageTemplate, T propertyValue)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Fatal(ex, "Process terminating.");

Fatal<T>(string, T)

Write a log event with the Fatal level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal<T>(string messageTemplate, T propertyValue)

Parameters

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Fatal("Process terminating.");

Fatal<T0, T1>(Exception?, string, T0, T1)

Write a log event with the Fatal level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal<T0, T1>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Fatal(ex, "Process terminating.");

Fatal<T0, T1>(string, T0, T1)

Write a log event with the Fatal level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal<T0, T1>(string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Fatal("Process terminating.");

Fatal<T0, T1, T2>(Exception?, string, T0, T1, T2)

Write a log event with the Fatal level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal<T0, T1, T2>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Fatal(ex, "Process terminating.");

Fatal<T0, T1, T2>(string, T0, T1, T2)

Write a log event with the Fatal level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Fatal<T0, T1, T2>(string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Fatal("Process terminating.");

ForContext(ILogEventEnricher)

Create a logger that enriches log events via the provided enrichers.

public ILogger ForContext(ILogEventEnricher enricher)

Parameters

enricher ILogEventEnricher

Enricher that applies in the context.

Returns

ILogger

A logger that will enrich log events as specified.

ForContext(IEnumerable<ILogEventEnricher>)

Create a logger that enriches log events via the provided enrichers.

public ILogger ForContext(IEnumerable<ILogEventEnricher> enrichers)

Parameters

enrichers IEnumerable<ILogEventEnricher>

Enrichers that apply in the context.

Returns

ILogger

A logger that will enrich log events as specified.

ForContext(string, object?, bool)

Create a logger that enriches log events with the specified property.

public ILogger ForContext(string propertyName, object? value, bool destructureObjects = false)

Parameters

propertyName string

The name of the property. Must be non-empty.

value object

The property value.

destructureObjects bool

If true, the value will be serialized as a structured object if possible; if false, the object will be recorded as a scalar or simple array.

Returns

ILogger

A logger that will enrich log events as specified.

ForContext(Type)

Create a logger that marks log events as being from the specified source type.

public ILogger ForContext(Type source)

Parameters

source Type

Type generating log messages in the context.

Returns

ILogger

A logger that will enrich log events as specified.

ForContext<TSource>()

Create a logger that marks log events as being from the specified source type.

public ILogger ForContext<TSource>()

Returns

ILogger

A logger that will enrich log events as specified.

Type Parameters

TSource

Type generating log messages in the context.

Information(Exception?, string)

Write a log event with the Information level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information(Exception? exception, string messageTemplate)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Examples

Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information(Exception?, string, params object?[]?)

Write a log event with the Information level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information(Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information(string)

Write a log event with the Information level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information(string messageTemplate)

Parameters

messageTemplate string

Message template describing the event.

Examples

Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information(string, params object?[]?)

Write a log event with the Information level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information(string messageTemplate, params object?[]? propertyValues)

Parameters

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information<T>(Exception?, string, T)

Write a log event with the Information level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information<T>(Exception? exception, string messageTemplate, T propertyValue)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information<T>(string, T)

Write a log event with the Information level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information<T>(string messageTemplate, T propertyValue)

Parameters

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information<T0, T1>(Exception?, string, T0, T1)

Write a log event with the Information level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information<T0, T1>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information<T0, T1>(string, T0, T1)

Write a log event with the Information level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information<T0, T1>(string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information<T0, T1, T2>(Exception?, string, T0, T1, T2)

Write a log event with the Information level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information<T0, T1, T2>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

Information<T0, T1, T2>(string, T0, T1, T2)

Write a log event with the Information level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Information<T0, T1, T2>(string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds);

IsEnabled(LogEventLevel)

Determine if events at the specified level, and higher, will be passed through to the log sinks.

public bool IsEnabled(LogEventLevel level)

Parameters

level LogEventLevel

Level to check.

Returns

bool

true if the level is enabled; otherwise, false.

Verbose(Exception?, string)

Write a log event with the Verbose level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose(Exception? exception, string messageTemplate)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Examples

Log.Verbose(ex, "Staring into space, wondering where this comet came from.");

Verbose(Exception?, string, params object?[]?)

Write a log event with the Verbose level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose(Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Verbose(ex, "Staring into space, wondering where this comet came from.");

Verbose(string)

Write a log event with the Verbose level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose(string messageTemplate)

Parameters

messageTemplate string

Message template describing the event.

Examples

Log.Verbose("Staring into space, wondering if we're alone.");

Verbose(string, params object?[]?)

Write a log event with the Verbose level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose(string messageTemplate, params object?[]? propertyValues)

Parameters

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Verbose("Staring into space, wondering if we're alone.");

Verbose<T>(Exception?, string, T)

Write a log event with the Verbose level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose<T>(Exception? exception, string messageTemplate, T propertyValue)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Verbose(ex, "Staring into space, wondering where this comet came from.");

Verbose<T>(string, T)

Write a log event with the Verbose level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose<T>(string messageTemplate, T propertyValue)

Parameters

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Verbose("Staring into space, wondering if we're alone.");

Verbose<T0, T1>(Exception?, string, T0, T1)

Write a log event with the Verbose level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose<T0, T1>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Verbose(ex, "Staring into space, wondering where this comet came from.");

Verbose<T0, T1>(string, T0, T1)

Write a log event with the Verbose level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose<T0, T1>(string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Verbose("Staring into space, wondering if we're alone.");

Verbose<T0, T1, T2>(Exception?, string, T0, T1, T2)

Write a log event with the Verbose level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose<T0, T1, T2>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Verbose(ex, "Staring into space, wondering where this comet came from.");

Verbose<T0, T1, T2>(string, T0, T1, T2)

Write a log event with the Verbose level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Verbose<T0, T1, T2>(string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Verbose("Staring into space, wondering if we're alone.");

Warning(Exception?, string)

Write a log event with the Warning level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning(Exception? exception, string messageTemplate)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Examples

Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length);

Warning(Exception?, string, params object?[]?)

Write a log event with the Warning level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning(Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length);

Warning(string)

Write a log event with the Warning level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning(string messageTemplate)

Parameters

messageTemplate string

Message template describing the event.

Examples

Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length);

Warning(string, params object?[]?)

Write a log event with the Warning level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning(string messageTemplate, params object?[]? propertyValues)

Parameters

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Examples

Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length);

Warning<T>(Exception?, string, T)

Write a log event with the Warning level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning<T>(Exception? exception, string messageTemplate, T propertyValue)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length);

Warning<T>(string, T)

Write a log event with the Warning level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning<T>(string messageTemplate, T propertyValue)

Parameters

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Examples

Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length);

Warning<T0, T1>(Exception?, string, T0, T1)

Write a log event with the Warning level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning<T0, T1>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length);

Warning<T0, T1>(string, T0, T1)

Write a log event with the Warning level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning<T0, T1>(string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Examples

Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length);

Warning<T0, T1, T2>(Exception?, string, T0, T1, T2)

Write a log event with the Warning level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning<T0, T1, T2>(Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length);

Warning<T0, T1, T2>(string, T0, T1, T2)

Write a log event with the Warning level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Warning<T0, T1, T2>(string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Examples

Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length);

Write(LogEvent)

Write an event to the log.

public void Write(LogEvent logEvent)

Parameters

logEvent LogEvent

The event to write.

Write(LogEventLevel, Exception?, string)

Write a log event with the specified level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write(LogEventLevel level, Exception? exception, string messageTemplate)

Parameters

level LogEventLevel

The level of the event.

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

Write(LogEventLevel, Exception?, string, params object?[]?)

Write a log event with the specified level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write(LogEventLevel level, Exception? exception, string messageTemplate, params object?[]? propertyValues)

Parameters

level LogEventLevel

The level of the event.

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValues object[]

Objects positionally formatted into the message template.

Write(LogEventLevel, string)

Write a log event with the specified level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write(LogEventLevel level, string messageTemplate)

Parameters

level LogEventLevel

The level of the event.

messageTemplate string

Message template describing the event.

Write(LogEventLevel, string, params object?[]?)

Write a log event with the specified level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write(LogEventLevel level, string messageTemplate, params object?[]? propertyValues)

Parameters

level LogEventLevel

The level of the event.

messageTemplate string

propertyValues object[]

Write<T>(LogEventLevel, Exception?, string, T)

Write a log event with the specified level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write<T>(LogEventLevel level, Exception? exception, string messageTemplate, T propertyValue)

Parameters

level LogEventLevel

The level of the event.

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Write<T>(LogEventLevel, string, T)

Write a log event with the specified level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write<T>(LogEventLevel level, string messageTemplate, T propertyValue)

Parameters

level LogEventLevel

The level of the event.

messageTemplate string

Message template describing the event.

propertyValue T

Object positionally formatted into the message template.

Type Parameters

T

Write<T0, T1>(LogEventLevel, Exception?, string, T0, T1)

Write a log event with the specified level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write<T0, T1>(LogEventLevel level, Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

level LogEventLevel

The level of the event.

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Write<T0, T1>(LogEventLevel, string, T0, T1)

Write a log event with the specified level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write<T0, T1>(LogEventLevel level, string messageTemplate, T0 propertyValue0, T1 propertyValue1)

Parameters

level LogEventLevel

The level of the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

Type Parameters

T0

T1

Write<T0, T1, T2>(LogEventLevel, Exception?, string, T0, T1, T2)

Write a log event with the specified level and associated exception.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write<T0, T1, T2>(LogEventLevel level, Exception? exception, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

level LogEventLevel

The level of the event.

exception Exception

Exception related to the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2

Write<T0, T1, T2>(LogEventLevel, string, T0, T1, T2)

Write a log event with the specified level.

[MessageTemplateFormatMethod("messageTemplate")]
public void Write<T0, T1, T2>(LogEventLevel level, string messageTemplate, T0 propertyValue0, T1 propertyValue1, T2 propertyValue2)

Parameters

level LogEventLevel

The level of the event.

messageTemplate string

Message template describing the event.

propertyValue0 T0

Object positionally formatted into the message template.

propertyValue1 T1

Object positionally formatted into the message template.

propertyValue2 T2

Object positionally formatted into the message template.

Type Parameters

T0

T1

T2