Table of Contents

Class SystemHealth

Namespace
BiExcellence.OpenBi.Api.SystemInfo
Assembly
BiExcellence.OpenBi.Api.Client.dll

The result of every health check, from GET /system/health.

public sealed record SystemHealth : ISystemHealth
Inheritance
object
SystemHealth
Implements

Properties

Checks

Each check's result.

[JsonPropertyName("checks")]
public List<SystemHealthCheck>? Checks { get; init; }

Property Value

List<SystemHealthCheck>

DurationMs

How long all checks took together, in milliseconds. They run in parallel.

[JsonPropertyName("durationMs")]
public double DurationMs { get; init; }

Property Value

double

Status

The worst status of all checks - what the anonymous /health/ready probe answers with.

[JsonPropertyName("status")]
public SystemHealthStatus Status { get; init; }

Property Value

SystemHealthStatus