Class OutboxQueueHealthCheck

Monitors the outbox, verifying that the messages are being processed.

Inheritance

object

OutboxQueueHealthCheck

Implements

IHealthCheck

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.HealthChecks

Assembly: Silverback.Integration.HealthChecks.dll

Syntax

public class OutboxQueueHealthCheck : IHealthCheck

Constructors

OutboxQueueHealthCheck(IOutboundQueueHealthCheckService)

Initializes a new instance of the OutboxQueueHealthCheck class.

Declaration

public OutboxQueueHealthCheck(IOutboundQueueHealthCheckService service)

Parameters

Type	Name	Description
IOutboundQueueHealthCheckService	service	The IOutboundQueueHealthCheckService implementation to be used to monitor the outbound queue.

Properties

MaxMessageAge

Gets or sets the maximum message age, the check will fail when a message exceeds this age (default is 30 seconds).

Declaration

public static TimeSpan MaxMessageAge { get; set; }

Property Value

Type	Description
TimeSpan

MaxQueueLength

Gets or sets the maximum amount of messages in the queue. The default is null, meaning unrestricted.

Declaration

public static int? MaxQueueLength { get; set; }

Property Value

Type	Description
int?

Methods

CheckHealthAsync(HealthCheckContext, CancellationToken)

Runs the health check, returning the status of the component being checked.

Declaration

public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
HealthCheckContext	context	A context object associated with the current execution.
CancellationToken	cancellationToken	A CancellationToken that can be used to cancel the health check.

Returns

Type	Description
Task<HealthCheckResult>	A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked.

Implements

IHealthCheck