Class HealthReport

Namespace

Acuit.Pinpoint.HealthChecks

Assembly

Acuit.Pinpoint.HealthChecks.dll

Represents the result of executing a group of IHealthCheck instances.

public sealed class HealthReport

Inheritance

object

HealthReport

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Constructors

HealthReport(IReadOnlyDictionary<string, HealthReportEntry>, TimeSpan)

Create a new HealthReport from the specified results.

public HealthReport(IReadOnlyDictionary<string, HealthReportEntry> entries, TimeSpan totalDuration)

Parameters

entries IReadOnlyDictionary<string, HealthReportEntry>

A IReadOnlyDictionary<TKey, TValue> containing the results from each health check.

totalDuration TimeSpan

A value indicating the time the health check service took to execute.

Exceptions

ArgumentNullException

entries is null.

Properties

Entries

A IReadOnlyDictionary<TKey, TValue> containing the results from each health check.

public IReadOnlyDictionary<string, HealthReportEntry> Entries { get; }

Property Value

IReadOnlyDictionary<string, HealthReportEntry>

Remarks

The keys in this dictionary map the name of each executed health check to a HealthReportEntry for the result data retruned from the corresponding health check.

Status

Gets a HealthStatus representing the aggregate status of all the health checks. The value of Status will be the most servere status reported by a health check. If no checks were executed, the value is always Healthy.

public HealthStatus Status { get; }

Property Value

HealthStatus

TotalDuration

Gets the time the health check service took to execute.

public TimeSpan TotalDuration { get; }

Property Value

TimeSpan