Class CircuitBreakerMiddleware
- Namespace
- Excalibur.Dispatch.Middleware.Resilience
- Assembly
- Excalibur.Dispatch.dll
Middleware that implements circuit breaker pattern to prevent cascading failures.
[AppliesTo(MessageKinds.All)]
public sealed class CircuitBreakerMiddleware : IDispatchMiddleware
- Inheritance
-
CircuitBreakerMiddleware
- Implements
- Inherited Members
- Extension Methods
Remarks
A fault from downstream is recorded against the circuit and then propagates unchanged, so an exception mapper or typed exception handler registered above still sees the original exception. The one failure this middleware produces itself is the rejection it returns while the circuit is open, which is its own outcome rather than a restatement of somebody else's fault.
Constructors
CircuitBreakerMiddleware(IOptions<CircuitBreakerOptions>, ITransportCircuitBreakerRegistry, ITelemetrySanitizer, ILogger<CircuitBreakerMiddleware>)
Middleware that implements circuit breaker pattern to prevent cascading failures.
public CircuitBreakerMiddleware(IOptions<CircuitBreakerOptions> options, ITransportCircuitBreakerRegistry registry, ITelemetrySanitizer sanitizer, ILogger<CircuitBreakerMiddleware> logger)
Parameters
optionsIOptions<CircuitBreakerOptions>The circuit breaker options.
registryITransportCircuitBreakerRegistryShared per-key circuit registry, so this middleware and the outbox and inbox drains see one circuit per dependency rather than three private ones.
sanitizerITelemetrySanitizerThe telemetry sanitizer for PII protection.
loggerILogger<CircuitBreakerMiddleware>The logger.
Remarks
A fault from downstream is recorded against the circuit and then propagates unchanged, so an exception mapper or typed exception handler registered above still sees the original exception. The one failure this middleware produces itself is the rejection it returns while the circuit is open, which is its own outcome rather than a restatement of somebody else's fault.
Properties
Stage
Gets the pipeline stage where this middleware should execute.
public DispatchMiddlewareStage? Stage { get; }
Property Value
- DispatchMiddlewareStage?
The pipeline stage for this middleware.
Remarks
The stage determines the execution order of middleware in the pipeline. If null, the middleware will be registered at the end of the pipeline. Stages are processed in numeric order, allowing fine-grained control over middleware execution sequence.
Methods
InvokeAsync(IDispatchMessage, IMessageContext, DispatchRequestDelegate, CancellationToken)
Processes the message within the middleware pipeline.
public ValueTask<IMessageResult> InvokeAsync(IDispatchMessage message, IMessageContext context, DispatchRequestDelegate nextDelegate, CancellationToken cancellationToken)
Parameters
messageIDispatchMessageThe message being processed.
contextIMessageContextThe message context containing metadata and processing state.
nextDelegateDispatchRequestDelegateThe delegate to invoke the next middleware in the pipeline.
cancellationTokenCancellationTokenThe cancellation token to observe.
Returns
- ValueTask<IMessageResult>
A ValueTask<TResult> representing the result of message processing, potentially modified by this middleware. ValueTask can avoid allocating a Task for a synchronously completed result; other dispatch work can still allocate.
Remarks
Implementations can execute logic before calling nextDelegate, after calling it, or both. To short-circuit the pipeline, don't call nextDelegate and return an appropriate result. The context can be used to share data between middleware components. Respect the cancellation token to support timeouts and graceful shutdown.
Exceptions
- ArgumentNullException
Thrown when message, context, or nextDelegate is null.
- OperationCanceledException
Thrown when the operation is cancelled.