Architecture

View as Markdown

This page explains how NeMo Relay connects scopes, middleware, plugins, events, and subscribers.

Architecture Diagram

This diagram shows how runtime hosts and integrations reach the shared Rust runtime. Plugin components install reusable behavior, and subscribers deliver event snapshots to in-process consumers or external backends.

Adaptive behavior is one plugin component installed through the same lifecycle as observability or PII redaction. It is not a separate runtime layer.

Runtime Model

NeMo Relay combines a small number of runtime pieces into one shared execution model:

Every managed tool or LLM call resolves the conditional and intercept middleware visible from the active scope before it executes. Payload sanitization and event publication are queued observability work: they do not delay the real callback or result, and flush_subscribers is the explicit delivery barrier. When the runtime emits an event, it records the active scope UUID as parentage. The scope stack changes as work opens and closes; the parent-linked event records remain available to subscribers.

Main Runtime Pieces

These components are the primary building blocks that make up the runtime model.

Scope Stack

The active scope stack defines the current context for runtime work. It establishes:

  • Parent-child relationships between events
  • Scope-local visibility for middleware and subscribers
  • Cleanup boundaries for scope-owned registrations
  • Isolation across concurrent requests or workers

Middleware Registries

The middleware registries hold the active intercepts and guardrails for tool and LLM execution. Request intercepts can rewrite real requests, conditional guardrails can reject execution, and sanitize guardrails can change emitted observability payloads. Managed helpers read those registries before invoking the real callback.

Async middleware callbacks are awaited as part of managed execution. The managed call does not advance past that middleware callback until the callback returns.

Plugin System

The plugin system installs reusable runtime components from configuration. A plugin can register middleware, subscribers, or related behavior without requiring each application call site to repeat the setup.

Event Emission

The runtime emits structured events for scopes, tools, LLMs, and named marks. Those parent-linked records are the canonical history of runtime behavior. Native Rust, Python, Node.js, and FFI event-producing APIs enqueue subscriber work and return without waiting for subscriber callbacks or exporter work.

Subscribers and Exporters

Subscribers consume event snapshots through the background dispatcher. Some stay in process. Exporter subscribers can write ATOF JSONL, project events into ATIF trajectories, or emit OpenTelemetry traces. Typical destinations include in-process application logic, local files and artifact pipelines, OTLP-compatible observability backends, and evaluation or visualization tools.

This delivery happens after event submission and is separate from awaited async middleware. Use the binding flush API when a test or shutdown path must wait for already queued subscriber work. For manually registered exporters, follow the exporter’s documented teardown order before process exit. The ATOF, OpenTelemetry, and OpenInference exporters deregister to stop new deliveries, force-flush queued work, and then shut down. The ATIF export operation drains queued subscriber work before taking its snapshot; after export, deregister the subscriber and clear the exporter state. Clearing plugin configuration owns teardown for plugin-installed exporters.

Where Runtime State Lives

Runtime state is easiest to understand by separating ownership from process-wide registration.

Scope Ownership

The scope stack defines:

  • Where work belongs
  • Which scope-local behavior is visible
  • When scope-local registrations are cleaned up
  • Whether concurrent requests stay isolated

Only scopes are pushed onto the stack. Managed LLM and tool calls emit lifecycle records that use the current top scope as parent_uuid; they do not become stack entries. This example shows an agent scope with a nested function scope named turn-a.

With turn-a at the top, managed LLM and tool records receive parent_uuid = turn-a, so they are siblings in the event tree. Popping turn-a returns agent-a to the top and removes registrations owned by the turn. A concurrent request uses a separate stack.

Middleware Ownership

Middleware exists at two levels:

  • global registrations stay active process-wide until removed
  • scope-local registrations are owned by one scope and disappear when that scope closes

That split lets long-lived defaults coexist with request-specific or task-specific behavior.

The following diagram shows how global and scope-local middleware are resolved for two concurrent requests.

Global entries are visible to both calls. Each scope-local entry is visible only through its owning stack and is removed when that scope closes.

Managed Execution Pipeline

Managed tool and LLM execution follows the same high-level order:

  1. Conditional-execution guardrails decide whether work can proceed.
  2. Request intercepts can rewrite the real request.
  3. Sanitize-request guardrails can rewrite the emitted start-event payload.
  4. Execution intercepts wrap or replace the user callback.
  5. The user callback runs.
  6. Sanitize-response guardrails can rewrite the emitted end-event payload.

The following sequence shows where each middleware family runs during a managed call.

Two distinctions matter:

  • Intercepts affect the real execution path
  • Sanitize guardrails affect the emitted observability payload

For the expanded request-to-response runtime path, including streaming and subscriber handoff, refer to Managed Execution Order.