Class BaseCheck

Base class for all Health Checks. Particular health checks must inherit from this class to be invoked

Inheritance
System.Object
BaseCheck
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Health
Assembly: NFX.dll
Syntax
[Config("/health-checks")]
public abstract class BaseCheck : IConfigurable

Fields

Result

Results property bag may be used for reporting of additional health-check parameters i.e. latency, content size etc...

Declaration
public readonly CheckResult Result
Field Value
Type Description
CheckResult

Properties

CanRun

Indicates whether this check will be executed

Declaration
[Config("@assembly@/@type@/$can-run")]
public virtual bool CanRun { get; set; }
Property Value
Type Description
System.Boolean

Description

Provides additional textual description of the check

Declaration
public virtual string Description { get; }
Property Value
Type Description
System.String

Name

Provides textual name for this check. Base implementation returns full type name

Declaration
public virtual string Name { get; }
Property Value
Type Description
System.String

Methods

Configure(IConfigSectionNode)

Declaration
public void Configure(IConfigSectionNode node)
Parameters
Type Name Description
IConfigSectionNode node

DoRun(NameValueCollection)

Override to provide particular health check implementation

Declaration
protected abstract void DoRun(NameValueCollection parameters)
Parameters
Type Name Description
System.Collections.Specialized.NameValueCollection parameters

Implements

Extension Methods