nemo_flow.observability

Observability plugin configuration helpers.

Attributes

OBSERVABILITY_PLUGIN_KIND

Classes

ConfigPolicy	Policy for unsupported observability configuration.
AtofConfig	Filesystem-backed raw ATOF JSONL export settings.
AtifConfig	Per-top-level-agent ATIF file export settings.
OtlpConfig	Shared OpenTelemetry/OpenInference OTLP export settings.
ObservabilityConfig	Canonical config document for the top-level observability component.
ComponentSpec	Top-level observability component wrapper.

Module Contents

class nemo_flow.observability.ConfigPolicy

Policy for unsupported observability configuration.

unknown_component: nemo_flow.UnsupportedBehavior = 'warn'

unknown_field: nemo_flow.UnsupportedBehavior = 'warn'

unsupported_value: nemo_flow.UnsupportedBehavior = 'error'

to_dict() → nemo_flow.JsonObject

Serialize this policy to the canonical JSON object shape.

class nemo_flow.observability.AtofConfig

Filesystem-backed raw ATOF JSONL export settings.

enabled: bool = False

output_directory: str | None = None

filename: str | None = None

mode: Literal['append', 'overwrite'] = 'append'

to_dict() → nemo_flow.JsonObject

Serialize this ATOF config to the canonical JSON object shape.

class nemo_flow.observability.AtifConfig

Per-top-level-agent ATIF file export settings.

enabled: bool = False

agent_name: str = 'NeMo Flow'

agent_version: str | None = None

model_name: str = 'unknown'

tool_definitions: list[nemo_flow.JsonObject] | None = None

extra: nemo_flow.JsonObject | None = None

output_directory: str | None = None

filename_template: str = 'nemo-flow-atif-{session_id}.json'

to_dict() → nemo_flow.JsonObject

Serialize this ATIF config to the canonical JSON object shape.

class nemo_flow.observability.OtlpConfig

Shared OpenTelemetry/OpenInference OTLP export settings.

enabled: bool = False

transport: Literal['http_binary', 'grpc'] = 'http_binary'

endpoint: str | None = None

headers: dict[str, str]

resource_attributes: dict[str, str]

service_name: str = 'nemo-flow'

service_namespace: str | None = None

service_version: str | None = None

instrumentation_scope: str | None = None

timeout_millis: int = 3000

to_dict() → nemo_flow.JsonObject

Serialize this OTLP config to the canonical JSON object shape.

class nemo_flow.observability.ObservabilityConfig

Canonical config document for the top-level observability component.

version: int = 1

atof: AtofConfig | None = None

atif: AtifConfig | None = None

opentelemetry: OtlpConfig | None = None

openinference: OtlpConfig | None = None

policy: ConfigPolicy

to_dict() → nemo_flow.JsonObject

Serialize this observability config to the canonical JSON object shape.

nemo_flow.observability.OBSERVABILITY_PLUGIN_KIND = 'observability'

class nemo_flow.observability.ComponentSpec

Top-level observability component wrapper.

config: ObservabilityConfig | nemo_flow.JsonObject

enabled: bool = True

to_dict() → nemo_flow.JsonObject

Serialize this component to the canonical plugin shape.