> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/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-resource-metrics

> Resource collection and measurement configuration for NeMo Relay.

Generated from `cargo doc --no-deps -p nemo-relay-builtins -p nemo-relay-diagnostics -p nemo-relay-logging -p nemo-relay-plugin-host -p nemo-relay-codecs -p nemo-relay -p nemo-relay-runtime -p nemo-relay-model-pricing -p nemo-relay-resource-metrics -p nemo-relay-observability -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker`.

Resource collection and measurement configuration for NeMo Relay.

## Re-exports

* `pub use manager::collect_on_demand as collect;`

## Modules

* [config](/reference/api/rust-library-reference/nemo-relay-resource-metrics/config): Collection settings and measurement units.
* [manager](/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager): Sampling ownership and polling lifecycle. Process resource collection, sampling ownership, and polling lifecycle.
* [plugin](/reference/api/rust-library-reference/nemo-relay-resource-metrics/plugin): Built-in component implementation. Built-in resource metrics plugin component.

## Enums

* [Error](/reference/api/rust-library-reference/nemo-relay-resource-metrics/enum-error): Collection errors use the shared Relay runtime error contract. The error type for all NeMo Relay runtime operations.

## Type Aliases

* [Result](/reference/api/rust-library-reference/nemo-relay-resource-metrics/type-result): Result of configuring or collecting resource metrics.

> Resource collection and measurement configuration for NeMo Relay.

## Docs

- [Module config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config.md): Collection settings and measurement units.
- [Struct Resource Memory Inspection Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcememoryinspectionconfig.md): Read-only latest memory projection. Does not enable polling or collection.
- [Struct Resource Metrics Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsconfig.md): Configuration for the built-in `resource_metrics` plugin component.
- [Struct Resource Metrics CpuConfig](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricscpuconfig.md): CPU observations, limits, and pressure.
- [Struct Resource Metrics CpuUnits](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricscpuunits.md): CPU measurement unit choices.
- [Struct Resource Metrics Disk Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsdiskconfig.md): Disk I/O for the selected process scope and filesystem capacity.
- [Struct Resource Metrics Disk Units](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsdiskunits.md): Disk measurement unit choices.
- [Struct Resource Metrics GpuConfig](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsgpuconfig.md): Accelerator observations.
- [Struct Resource Metrics GpuUnits](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsgpuunits.md): GPU measurement unit choices.
- [Struct Resource Metrics Memory Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsmemoryconfig.md): Memory observations, limits, pressure, and OOM events.
- [Struct Resource Metrics Memory Units](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsmemoryunits.md): Memory measurement unit choices.
- [Struct Resource Metrics Network Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsnetworkconfig.md): System interface counters. Empty `interfaces` selects every visible interface.
- [Struct Resource Metrics Network Traffic Units](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsnetworktrafficunits.md): Unit choices for one group of network traffic.
- [Struct Resource Metrics Network Units](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsnetworkunits.md): Unit choices for system and interface traffic.
- [Struct Resource Metrics Polling Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricspollingconfig.md): Periodic collection controlled by the `resource_metrics` plugin component.
- [Struct Resource Metrics Process Config](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsprocessconfig.md): Process, thread, handle, descriptor, and process-limit observations.
- [Struct Resource Metrics Units](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/struct-resourcemetricsunits.md): Output unit choices for resource metrics.
- [Enum Bandwidth Unit](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-bandwidthunit.md): Units for data transferred per second.
- [Enum Capacity Unit](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-capacityunit.md): Units for memory and filesystem capacity.
- [Enum CpuUnit](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-cpuunit.md): Units for CPU consumption and effective capacity.
- [Enum Data Unit](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-dataunit.md): Units for cumulative transferred data.
- [Enum Duration Unit](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-durationunit.md): Units for elapsed and cumulative durations.
- [Enum Resource Metrics Measurement Scope](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-resourcemetricsmeasurementscope.md): Measurement boundary selected for resource metric collection.
- [Enum Utilization Unit](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/config/enum-utilizationunit.md): Units for GPU compute utilization.
- [Module manager](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager.md): Sampling ownership and polling lifecycle. Process resource collection, sampling ownership, and polling lifecycle.
- [Struct Resource Metrics Runtime](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/struct-resourcemetricsruntime.md): Owns the optional resource metrics polling thread for a built-in plugin activation.
- [Function collect_on_demand](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-collect-on-demand.md): API documentation for the Rust `collect_on_demand` fn in crate `nemo_relay_resource_metrics`.
- [Function ensure_process_owner](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-ensure-process-owner.md): API documentation for the Rust `ensure_process_owner` fn in crate `nemo_relay_resource_metrics`.
- [Function invalidated_snapshot](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-invalidated-snapshot.md): API documentation for the Rust `invalidated_snapshot` fn in crate `nemo_relay_resource_metrics`.
- [Function latest_memory_view](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-latest-memory-view.md): Read an existing manager only. Inspection must not resolve settings, start a manager, collect, or retarget it. Fork checks precede every potentially inherited lock.
- [Function prepare_cli_owned_process_tree](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-prepare-cli-owned-process-tree.md): API documentation for the Rust `prepare_cli_owned_process_tree` fn in crate `nemo_relay_resource_metrics`.
- [Function runtime_inherited_across_fork](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-runtime-inherited-across-fork.md): API documentation for the Rust `runtime_inherited_across_fork` fn in crate `nemo_relay_resource_metrics`.
- [Function target_owned_process_tree](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/fn-target-owned-process-tree.md): API documentation for the Rust `target_owned_process_tree` fn in crate `nemo_relay_resource_metrics`.
- [Type Alias Snapshot Sink](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/manager/type-snapshotsink.md): Receives each periodic resource snapshot.
- [Module plugin](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/plugin.md): Built-in component implementation. Built-in resource metrics plugin component.
- [Struct Resource Metrics Plugin](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/plugin/struct-resourcemetricsplugin.md): Built-in resource metrics component.
- [Constant RESOURCE_METRICS_PLUGIN_KIND](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/plugin/constant-resource-metrics-plugin-kind.md): Plugin kind used by the resource metrics component.
- [Enum Error](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/enum-error.md): Collection errors use the shared Relay runtime error contract. The error type for all NeMo Relay runtime operations.
- [Type Alias Result](https://docs.nvidia.com/nemo/relay/dev/reference/api/rust-library-reference/nemo-relay-resource-metrics/type-result.md): Result of configuring or collecting resource metrics.