Metadata¶

group DCGMAPI_METADATA

This chapter describes the methods that query for DCGM metadata.

Functions

dcgmReturn_t dcgmIntrospectGetHostengineMemoryUsage(dcgmHandle_t pDcgmHandle, dcgmIntrospectMemory_t *memoryInfo, int waitIfNoData)¶

Retrieve the total amount of memory that the hostengine process is currently using.

This measurement represents both the resident set size (what is currently in RAM) and the swapped memory that belongs to the process.

Parameters:

pDcgmHandle – IN: DCGM Handle
memoryInfo – IN/OUT: see dcgmIntrospectMemory_t. memoryInfo->version must be set to dcgmIntrospectMemory_version prior to this call.
waitIfNoData – IN: if no metadata is gathered wait till this occurs (!0) or return DCGM_ST_NO_DATA (0)

Returns:

DCGM_ST_OK if the call was successful
DCGM_ST_NOT_CONFIGURED if metadata gathering state is DCGM_INTROSPECT_STATE_DISABLED
DCGM_ST_NO_DATA if waitIfNoData is false and metadata has not been gathered yet
DCGM_ST_VER_MISMATCH if memoryInfo->version is 0 or invalid.

dcgmReturn_t dcgmIntrospectGetHostengineCpuUtilization(dcgmHandle_t pDcgmHandle, dcgmIntrospectCpuUtil_t *cpuUtil, int waitIfNoData)¶

Retrieve the CPU utilization of the DCGM hostengine process.

Parameters:

pDcgmHandle – IN: DCGM Handle
cpuUtil – IN/OUT: see dcgmIntrospectCpuUtil_t. cpuUtil->version must be set to dcgmIntrospectCpuUtil_version prior to this call.
waitIfNoData – IN: if no metadata is gathered wait till this occurs (!0) or return DCGM_ST_NO_DATA (0)

Returns:

DCGM_ST_OK if the call was successful
DCGM_ST_NOT_CONFIGURED if metadata gathering state is DCGM_INTROSPECT_STATE_DISABLED
DCGM_ST_NO_DATA if waitIfNoData is false and metadata has not been gathered yet
DCGM_ST_VER_MISMATCH if cpuUtil->version or execTime->version is 0 or invalid.