Dump metrics raw data

Overview

These APIs are for collecting metrics raw data More…

// global functions

XPUM_API xpum_result_t xpumStartDumpRawDataTask(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    const xpum_dump_type_t dumpTypeList[],
    const int count,
    const char* dumpFilePath,
    xpum_dump_raw_data_task_t* taskInfo
    );

XPUM_API xpum_result_t xpumStartDumpRawDataTaskEx(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    const xpum_dump_type_t dumpTypeList[],
    const int count,
    const char* dumpFilePath,
    xpum_dump_raw_data_option_t dumpOptions,
    xpum_dump_raw_data_task_t* taskInfo
    );

XPUM_API xpum_result_t xpumStopDumpRawDataTask(
    xpum_dump_task_id_t taskId,
    xpum_dump_raw_data_task_t* taskInfo
    );

XPUM_API xpum_result_t xpumListDumpRawDataTasks(
    xpum_dump_raw_data_task_t taskList[],
    int* count
    );

Detailed Documentation

These APIs are for collecting metrics raw data

Global Functions

XPUM_API xpum_result_t xpumStartDumpRawDataTask(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    const xpum_dump_type_t dumpTypeList[],
    const int count,
    const char* dumpFilePath,
    xpum_dump_raw_data_task_t* taskInfo
    )

Start dump raw data task. When call this function, core lib will start to write raw data into dump file.

Support Platform: Linux

Parameters:

deviceId	IN: Device id to query
tileId	IN: tile id to query, when pass -1, means to get device level data
dumpTypeList	IN: metrics to dump
count	IN: The count of entries in metricsTypeList
dumpFilePath	IN: The path of file to dump raw data
taskInfo	OUT: The info of the task just created

Returns:

xpum_result_t

XPUM_OK if query successfully
XPUM_RESULT_DUMP_METRICS_TYPE_NOT_SUPPORT if not supported metrics type passed in
XPUM_GENERIC_ERROR if other error happens

XPUM_API xpum_result_t xpumStartDumpRawDataTaskEx(
    xpum_device_id_t deviceId,
    xpum_device_tile_id_t tileId,
    const xpum_dump_type_t dumpTypeList[],
    const int count,
    const char* dumpFilePath,
    xpum_dump_raw_data_option_t dumpOptions,
    xpum_dump_raw_data_task_t* taskInfo
    )

Start dump raw data task. When call this function, core lib will start to write raw data into dump file.

Support Platform: Linux

Parameters:

deviceId	IN: Device id to query
tileId	IN: tile id to query, when pass -1, means to get device level data
dumpTypeList	IN: metrics to dump
count	IN: The count of entries in metricsTypeList
dumpFilePath	IN: The path of file to dump raw data
dumpOptions	IN: Dump Options for Raw Data Task
taskInfo	OUT: The info of the task just created

Returns:

xpum_result_t

XPUM_OK if query successfully
XPUM_RESULT_DUMP_METRICS_TYPE_NOT_SUPPORT if not supported metrics type passed in
XPUM_GENERIC_ERROR if other error happens

XPUM_API xpum_result_t xpumStopDumpRawDataTask(
    xpum_dump_task_id_t taskId,
    xpum_dump_raw_data_task_t* taskInfo
    )

Stop write to dumpFilePath.

Support Platform: Linux

Parameters:

taskId	IN: Task id
taskInfo	OUT: The info of the task just stopped

Returns:

xpum_result_t

XPUM_OK if query successfully
XPUM_DUMP_RAW_DATA_TASK_NOT_EXIST if task id not exists
XPUM_GENERIC_ERROR if other error happens

XPUM_API xpum_result_t xpumListDumpRawDataTasks(
    xpum_dump_raw_data_task_t taskList[],
    int* count
    )

List all the active dump tasks.

Support Platform: Linux

Parameters:

taskList	OUT: The array to store task info. First pass NULL to query raw data count. Then pass array with desired length to store raw data.
count	IN/OUT: When taskList is NULL, count will be filled with the number of running tasks, and return. When taskList is not NULL, count denotes the length of taskList, count should be equal to or larger than the number of running tasks, when return, the count will store real number of entries returned by taskList

Returns:

xpum_result_t

XPUM_OK if query successfully
XPUM_GENERIC_ERROR if other error happens