dcgmi introspect#

NAME#

dcgmi-introspect - report DCGM host-engine resource use

SYNOPSIS#

dcgmi introspect --show --hostengine [--host <address>]

DESCRIPTION#

dcgmi introspect queries DCGM’s introspection module. DCGM 4.6 exposes one command-line target: the host-engine process. The report contains host-engine memory use and CPU utilization when introspection data is available.

OPTIONS#

-s, --show: Display introspection information. --hostengine is required.
-H, --hostengine: Select the host-engine process as the introspection target.
--host <address>: Connect to the specified host engine.
-h, --help: Print generated usage information and exit.

OUTPUT REFERENCE#

The report has two values:

Host-engine introspection values#
Value	Interpretation
`Memory`	Host-engine bytes reported by DCGM, divided by 1,024 and printed as `KB` with one decimal place
`CPU Utilization`	DCGM’s total host-engine CPU-utilization fraction, multiplied by 100 and printed as a percentage with two decimal places

The command asks the introspection module to wait for data when no sample is yet available, so the first query can take longer than later queries. Module status can be checked with dcgmi modules --list; Not loaded is normal before the first introspection request because modules are loaded lazily.

In DCGM 4.6, failure of an individual memory or CPU query is rendered as Error in that row, but the display function still returns success. Scripts must inspect the values as well as the process status. A connection failure or failure before the display function is entered still produces a nonzero exit status.

EXAMPLES#

Display local host-engine resource use:

$ dcgmi introspect --show --hostengine

Display resource use for a remote host engine:

$ dcgmi introspect --show --hostengine --host node01.example.com