Interface IHealthDiagnosticsSource

Read-only health diagnostics source — the surface the HealthPlugin registers under CAPABILITIES.HEALTH_DIAGNOSTICS and the DiagnosticsPlugin consumes to serve GET /v1/health.

Synchronous by contract: snapshot(instanceId) returns an already-built frozen DTO and never invokes an application indicator, resolves a lazy factory, or mutates state. The connector validates the returned DTO and applies the wire bounds; a source that throws is reported as a value-free collection-failed snapshot, never as a fault that changes the application's readiness.

Example

const source = ctx.services.get<IHealthDiagnosticsSource>(
  CAPABILITIES.HEALTH_DIAGNOSTICS,
);
const snapshot = source.snapshot(instanceId);

Since

0.8.0

interface IHealthDiagnosticsSource {
snapshot(instanceId: string): HealthDiagnosticsSnapshot;
}

Index

Methods

snapshot

Methods

snapshot

snapshot(instanceId: string): HealthDiagnosticsSnapshot
Returns the current minimized health snapshot for the given instance.
Parameters
- instanceId: string
  The non-empty instance UUID to bind the snapshot to
Returns HealthDiagnosticsSnapshot
A deeply frozen HealthDiagnosticsSnapshot whose instanceId exactly equals the argument

Throws
When instanceId is not a non-empty string — with a fixed message that never echoes the value
- Defined in packages/common/src/services/diagnostics.ts:452

Interface IHealthDiagnosticsSource

Example

Since

Index

Methods

Methods

snapshot

Parameters

Returns HealthDiagnosticsSnapshot

Throws

Settings

On This Page