View Source

Class HealthCheck

Provides a base class for health checks, filling in the healthcheck metadata on construction

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.HealthChecks

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "healthCheck", Namespace = "")]
public abstract class HealthCheck : IDiscoverable

Constructors

HealthCheck()

Declaration

protected HealthCheck()

Properties

Description

Declaration

[DataMember(Name = "description")]
public string Description { get; }

Property Value

Type	Description
System.String

Group

Declaration

[DataMember(Name = "group")]
public string Group { get; }

Property Value

Type	Description
System.String

Id

Declaration

[DataMember(Name = "id")]
public Guid Id { get; }

Property Value

Type	Description
Guid

Name

Declaration

[DataMember(Name = "name")]
public string Name { get; }

Property Value

Type	Description
System.String

Methods

ExecuteAction(HealthCheckAction)

Executes the action and returns it's status

Declaration

public virtual HealthCheckStatus ExecuteAction(HealthCheckAction action)

Parameters

Type	Name	Description
HealthCheckAction	action

Returns

Type	Description
HealthCheckStatus

ExecuteActionAsync(HealthCheckAction)

Executes the action and returns it's status

Declaration

public virtual Task<HealthCheckStatus> ExecuteActionAsync(HealthCheckAction action)

Parameters

Type	Name	Description
HealthCheckAction	action

Returns

Type	Description
Task<HealthCheckStatus>

GetStatus()

Get the status for this health check

Declaration

public virtual Task<IEnumerable<HealthCheckStatus>> GetStatus()

Returns

Type	Description
Task<IEnumerable<HealthCheckStatus>>

Remarks

If there are possible actions to take to rectify this check, this method must be overridden by a sub class in order to explicitly provide those actions.

GetStatusAsync()

Get the status for this health check

Declaration

public virtual Task<IEnumerable<HealthCheckStatus>> GetStatusAsync()

Returns

Type	Description
Task<IEnumerable<HealthCheckStatus>>

Remarks

If there are possible actions to take to rectify this check, this method must be overridden by a sub class in order to explicitly provide those actions.