Interface IConfigDiagnosticsSource

Read-only configuration provenance source — the surface the ConfigPlugin registers under CAPABILITIES.CONFIG_DIAGNOSTICS and the DiagnosticsPlugin consumes to serve GET /v1/config.

Synchronous by contract: snapshot(instanceId) returns an already-built frozen DTO and performs no environment, filesystem, schema, or lazy-service operation, adds no read to the underlying IConfig, and never enumerates it. A source that throws is reported by the connector as a value-free collection-failed snapshot, never as a fault that changes application behavior.

Example

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

Since

0.8.0

interface IConfigDiagnosticsSource {
snapshot(instanceId: string): ConfigDiagnosticsSnapshot;
}

Index

Methods

snapshot

Methods

snapshot

snapshot(instanceId: string): ConfigDiagnosticsSnapshot
Returns the current minimized provenance snapshot for the given instance.
Parameters
- instanceId: string
  The non-empty instance UUID to bind the snapshot to
Returns ConfigDiagnosticsSnapshot
A deeply frozen ConfigDiagnosticsSnapshot 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:585

Interface IConfigDiagnosticsSource

Example

Since

Index

Methods

Methods

snapshot

Parameters

Returns ConfigDiagnosticsSnapshot

Throws

Settings

On This Page