Skip to navigation
ReferenceAPIPython Library Reference

Runtime Health

View as Markdown

module nemo_fabric.check

Health requests and immutable health reports.


class CheckRequest

Select server, runtime, or registered service health.

Runtime and service checks default to live. One positive, finite timeout covers all requested levels. Server checks reject runtime IDs, service IDs, and levels, including explicit nulls.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
schema_versionLiteral['fabric.check/v1alpha1']No'fabric.check/v1alpha1'——
scopeLiteral['server', 'runtime', 'service']Yes———
runtime_idstr | NoneNoNone——
service_idstr | NoneNoNone——
levelCheckLevel | NoneNoNone——
timeout_secondsfloatNo3.0Gt(gt=0)—

property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached request using the defaulted level and timeout.


class CheckReport

Immutable health check report.

to_mapping() returns detached JSON data.

Fields

The mapping exposes the following typed fields:

FieldType
schema_versionstr
scopestr
runtime_idstr | None
requested_levelstr | None
outcomestr
reason_codestr | None
completed_atstr
elapsed_msfloat
serverMapping[str, Any] | None
runtimeMapping[str, Any] | None
checkslist[Mapping[str, Any]]

property extra_fields

Return an immutable view of preserved extension fields.


property service_id

Return the selected service, or null for other check targets.


This file was automatically generated via lazydocs.