Method AddShortLivedStoreCheck

AddShortLivedStoreCheck(IHealthChecksBuilder, string?, string?, HealthStatus?, IEnumerable<string>?)

Adds a check of a short-lived store: the store of the app's own values, or the store of a key of ShortLivedStoreKeys (see GetUsageAsync(CancellationToken)).

Declaration

public static IHealthChecksBuilder AddShortLivedStoreCheck(this IHealthChecksBuilder builder, string? key = null, string? name = null, HealthStatus? failureStatus = null, IEnumerable<string>? tags = null)

Parameters

Type	Name	Description
IHealthChecksBuilder	builder	The health checks builder.
string	key	The key of the store, or null for the store registered without a key.
string	name	The name of the check. Default is httpapi-short-lived-store, followed by the key without its httpapi: prefix after a dash, such as httpapi-short-lived-store-sign-in.
HealthStatus?	failureStatus	The status that a failure reports. Default is Unhealthy.
IEnumerable<string>	tags	The tags of the check. Default is httpapi and short-lived-store.

Returns

Type	Description
IHealthChecksBuilder

Remarks

It reports the failure status if the store can't be read, Degraded if it refused a write because it was full within the last minute, whatever the failure status, or is more than 90% full, and Healthy otherwise. Its values are under the keys of HttpApiHealthCheckData.ShortLivedStore.