Class HealthCheckPublisherOptions

Namespace

Acuit.Pinpoint.HealthChecks

Assembly

Acuit.Pinpoint.HealthChecks.dll

Options for the default service that executes IHealthCheckPublisher instances.

public sealed class HealthCheckPublisherOptions

Inheritance

object

HealthCheckPublisherOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Delay

Gets or sets the initial delay applied after the application starts before executing IHealthCheckPublisher instances. The delay is applied once at startup, and does not apply to subsequent iterations. The default value is 5 seconds.

public TimeSpan Delay { get; set; }

Property Value

TimeSpan

Period

Gets or sets the period of IHealthCheckPublisher execution. The default value is 30 seconds.

public TimeSpan Period { get; set; }

Property Value

TimeSpan

Remarks

The Period cannot be set to a value lower than 1 second.

Predicate

Gets or sets a predicate that is used to filter the set of health checks executed.

public Func<HealthCheckRegistration, bool> Predicate { get; set; }

Property Value

Func<HealthCheckRegistration, bool>

Remarks

If Predicate is null, the health check publisher service will run all registered health checks - this is the default behavior. To run a subset of health checks, provide a function that filters the set of checks. The predicate will be evaluated each period.

Timeout

Gets or sets the timeout for executing the health checks on all IHealthCheckPublisher instances. Use InfiniteTimeSpan to execute with no timeout. The default value is 30 seconds.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan