Table of Contents

Class LoggingPipelineExtensions

Namespace
Microsoft.Extensions.DependencyInjection
Assembly
Excalibur.Dispatch.dll

Extension methods for adding logging middleware to the pipeline.

public static class LoggingPipelineExtensions
Inheritance
LoggingPipelineExtensions
Inherited Members

Methods

UseLogging(IDispatchBuilder)

Adds logging middleware to the dispatch pipeline with default configuration.

public static IDispatchBuilder UseLogging(this IDispatchBuilder builder)

Parameters

builder IDispatchBuilder

The dispatch builder.

Returns

IDispatchBuilder

The builder for fluent configuration.

Remarks

The logging middleware logs the start and completion of message processing with configurable log levels, timing information, and optional payload inclusion.

Default configuration:

  • SuccessLevel: Information
  • FailureLevel: Error
  • IncludePayload: false (for security)
  • IncludeTiming: true

UseLogging(IDispatchBuilder, Action<LoggingMiddlewareOptions>)

Adds logging middleware to the dispatch pipeline with custom configuration.

public static IDispatchBuilder UseLogging(this IDispatchBuilder builder, Action<LoggingMiddlewareOptions> configure)

Parameters

builder IDispatchBuilder

The dispatch builder.

configure Action<LoggingMiddlewareOptions>

Action to configure logging options.

Returns

IDispatchBuilder

The builder for fluent configuration.

Remarks

Use this overload to customize logging behavior:

dispatch.UseLogging(options =>
{
    options.SuccessLevel = LogLevel.Debug;
    options.IncludeTiming = true;
    options.ExcludeTypes.Add(typeof(HealthCheckQuery));
});