> This page is for NeMo Relay, version dev.
> For other versions, use one of these documentation indexes:
> - Latest (v0.10.4) (default): https://docs.nvidia.com/nemo/relay/latest/llms.txt
> - dev: https://docs.nvidia.com/nemo/relay/dev/llms.txt
> - v0.11.0: https://docs.nvidia.com/nemo/relay/v0.11.0/llms.txt
> - v0.10.4: https://docs.nvidia.com/nemo/relay/v0.10.4/llms.txt
> - v0.9.4: https://docs.nvidia.com/nemo/relay/v0.9.4/llms.txt
> - v0.8.4: https://docs.nvidia.com/nemo/relay/v0.8.4/llms.txt
> - v0.7.3: https://docs.nvidia.com/nemo/relay/v0.7.3/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/relay/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/relay/_mcp/server.

# nemo_relay.diagnostics

> Optional readers for configuration-driven, process-local diagnostics.

Generated from `python/nemo_relay/diagnostics.py`.

Module `nemo_relay.diagnostics`.

Optional readers for configuration-driven, process-local diagnostics.

## Classes

### `DiagnosticsError(RuntimeError)`

Reader failure with a stable machine-readable `reason`.

#### Methods

##### `DiagnosticsError`

```python
def DiagnosticsError(reason: str) -> None
```

Create an instance.

### `DiagnosticsReader`

Read-only service capability, independent of plugin activation lifetime.

#### Methods

##### `DiagnosticsReader`

```python
def DiagnosticsReader(native: _NativeReader) -> None
```

Create an instance.

##### `snapshot`

```python
def snapshot(query: dict[str, Any] | None = None) -> dict[str, Any]
```

Return one bounded page; diagnostic counters and durations are int.

##### `snapshot_json`

```python
def snapshot_json(query: dict[str, Any] | None = None) -> str
```

Return canonical JSON with decimal-string diagnostic integers.

##### `inspect_memory`

```python
def inspect_memory(query: dict[str, Any] | None = None) -> dict[str, Any]
```

Return one bounded memory page; diagnostic counters and durations are int.

##### `inspect_memory_json`

```python
def inspect_memory_json(query: dict[str, Any] | None = None) -> str
```

Return canonical JSON with decimal-string diagnostic integers.

##### `info`

```python
def info() -> dict[str, Any]
```

Return separate core/copy budgets, occupancy, and logging coverage.

## Functions

### `reader`

```python
def reader() -> DiagnosticsReader
```

Obtain a reader for the process diagnostics service.