NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
telemetry_diag_sample_cfg Struct Reference

#include </opt/mellanox/doca/samples/doca_telemetry/telemetry_diag/telemetry_diag_sample.h>

Collaboration diagram for telemetry_diag_sample_cfg:

Data Fields

char data_ids_input_path [TELEMETRY_DIAG_SAMPLE_MAX_FILE_NAME]
 
char output_path [TELEMETRY_DIAG_SAMPLE_MAX_FILE_NAME]
 
char data_ids_example_export_path [TELEMETRY_DIAG_SAMPLE_MAX_FILE_NAME]
 
uint64_t sample_period
 
struct data_id_entrydata_ids_struct
 
uint32_t run_time
 
uint32_t max_num_samples_per_read
 
uint32_t num_data_ids
 
enum doca_telemetry_diag_sync_mode sync_mode
 
enum doca_telemetry_diag_sample_mode sample_mode
 
enum doca_telemetry_diag_output_format output_format
 
uint8_t log_max_num_samples
 
uint8_t force_ownership
 
uint8_t export_json
 
uint8_t import_json
 
uint8_t pci_set
 
char pci_addr [DOCA_DEVINFO_PCI_ADDR_SIZE]
 

Detailed Description

Definition at line 35 of file telemetry_diag_sample.h.

Field Documentation

◆ data_ids_example_export_path

char telemetry_diag_sample_cfg::data_ids_example_export_path[TELEMETRY_DIAG_SAMPLE_MAX_FILE_NAME]

output file for example json dump

Definition at line 38 of file telemetry_diag_sample.h.

◆ data_ids_input_path

char telemetry_diag_sample_cfg::data_ids_input_path[TELEMETRY_DIAG_SAMPLE_MAX_FILE_NAME]

data ids input file path

Definition at line 36 of file telemetry_diag_sample.h.

◆ data_ids_struct

struct data_id_entry* telemetry_diag_sample_cfg::data_ids_struct

array of data_id_entry structures

Definition at line 41 of file telemetry_diag_sample.h.

◆ export_json

uint8_t telemetry_diag_sample_cfg::export_json

whether the user chose to export example json

Definition at line 50 of file telemetry_diag_sample.h.

◆ force_ownership

uint8_t telemetry_diag_sample_cfg::force_ownership

force ownership when creating diag context

Definition at line 49 of file telemetry_diag_sample.h.

◆ import_json

uint8_t telemetry_diag_sample_cfg::import_json

whether an input data_ids json path was given

Definition at line 51 of file telemetry_diag_sample.h.

◆ log_max_num_samples

uint8_t telemetry_diag_sample_cfg::log_max_num_samples

log max number of samples to be used

Definition at line 48 of file telemetry_diag_sample.h.

◆ max_num_samples_per_read

uint32_t telemetry_diag_sample_cfg::max_num_samples_per_read

max number of samples for each read

Definition at line 43 of file telemetry_diag_sample.h.

◆ num_data_ids

uint32_t telemetry_diag_sample_cfg::num_data_ids

the number of entries in the data_ids_struct

Definition at line 44 of file telemetry_diag_sample.h.

◆ output_format

enum doca_telemetry_diag_output_format telemetry_diag_sample_cfg::output_format

output format to be used

Definition at line 44 of file telemetry_diag_sample.h.

◆ output_path

char telemetry_diag_sample_cfg::output_path[TELEMETRY_DIAG_SAMPLE_MAX_FILE_NAME]

output file path

Definition at line 37 of file telemetry_diag_sample.h.

◆ pci_addr

char telemetry_diag_sample_cfg::pci_addr[DOCA_DEVINFO_PCI_ADDR_SIZE]

PCI address to be used

Definition at line 53 of file telemetry_diag_sample.h.

◆ pci_set

uint8_t telemetry_diag_sample_cfg::pci_set

whether the user provided a pci address

Definition at line 52 of file telemetry_diag_sample.h.

◆ run_time

uint32_t telemetry_diag_sample_cfg::run_time

total sample run time, in seconds

Definition at line 42 of file telemetry_diag_sample.h.

◆ sample_mode

enum doca_telemetry_diag_sample_mode telemetry_diag_sample_cfg::sample_mode

sample mode to be used

Definition at line 44 of file telemetry_diag_sample.h.

◆ sample_period

uint64_t telemetry_diag_sample_cfg::sample_period

sample period to be used

Definition at line 40 of file telemetry_diag_sample.h.

◆ sync_mode

enum doca_telemetry_diag_sync_mode telemetry_diag_sample_cfg::sync_mode

sync mode to be used

Definition at line 44 of file telemetry_diag_sample.h.


The documentation for this struct was generated from the following file: