Class ApplicationHealthCheckOptions

Namespace

ProjectTemplate.Web.Options

Assembly

ProjectTemplate.Web.dll

Represents application health check configuration.

public sealed class ApplicationHealthCheckOptions

Inheritance

object

ApplicationHealthCheckOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Fields

SectionName

Configuration section name for health check settings.

public const string SectionName = "ProjectTemplate:HealthChecks"

Field Value

string

Properties

DatabaseReadinessCheckEnabled

Gets or sets a value indicating whether /health/ready includes an application database connectivity check when EF Core data access is enabled.

public bool DatabaseReadinessCheckEnabled { get; set; }

Property Value

bool

Remarks

Defaults to true so readiness reflects whether the instance can reach the database it needs to serve traffic. The check is not registered when the data access provider is None. The value is read each time the check runs; when it is false, the registered check reports healthy without contacting the database.