Networking UFM Telemetry Documentation

Settings and Configuration

Inside the container, the directory /config contains the configuration files for the NVIDIA® UFM® Telemetry application. The file launch_ibdiagnet_config.ini is the main configuration file.

The following table lists the basic configuration parameters in launch_ibdiagnet_config.ini.

Section

Key

Type

Default Value

Description

ibdiagnet

ibdiagnet_enabled

bool

true

Enable or disable running the ibdiagnet process.

data_dir

String

/data

Directory in which UFM Telemetry data is placed

ibdiag_output_dir

String

/tmp/ibd

Directory in which ibdiagnet places files

sample_rate

Int

-

Interval, in seconds, at which port counter data is collected

hca

String

mlx5_2

The HCA to use. You can provide a comma-separated list of HCAs for local high availability

force_hca

bool

false

Skip the HCA state check

app_name

String

/opt/collectx/bin/ibdiagnet

The full path of the ibdiagnet application, if you need to specify it

topology_mode

String

discover

Topology policy

topology_discovery_factor

Int

0

Every "n" iterations, do discovery, otherwise, use result from last run if 0 or 1

m_key

int

-

Set the m_key that ibdiagnet uses for data collection

xdr

XDR

bool

false

Enable this setting in XDR environments to configure additional required indexes

Retention

retention_enabled

bool

true

Enable or disable the retention service

retention_interval

time

1d

Interval to wait before running the retention process

retention_age

time

100d

Period for which to retain the collected data

compression

compression_enable

bool

true

Enable or disable the compression service

compression_interval

time

6h

Interval to wait before running the compression service

compression_age

time

12h

Period to reserve the compressed data

cable_info

cable_info_schedule

CSV

-

weekday/hr:min,hr:hm

Time to collect cable info data

Log File Rotation

The log rotation mechanism monitors the size of the UFM Telemetry log file ibdiagnet2_port_counters.log. Log rotation is especially useful for long run times or high verbosity, when the number of log files can grow very large.

To disable log rotation, set the following flag to 0 (the default is 1):

plugin_env_CLX_LOG_ROTATE_ENABLED

To change the number of rotated files, set the following flag (the default is 3):

plugin_env_CLX_LOG_ROTATE_NUM_FILES

To change the rotation threshold, set the following flag (the default is 100M). Use K, M, or G as the unit:

plugin_env_CLX_LOG_ROTATE_SIZE

UFM Telemetry supports three rotation methods and tries them in the following order:

  1. rotatelogs: If this executable exists, UFM Telemetry uses it to rotate logs and names the rotated files with an index suffix.

  2. logrotate: If this executable exists, UFM Telemetry uses it to rotate logs and names the rotated files with a timestamp suffix.

  3. Manual rotation: If neither executable is available, UFM Telemetry rotates two log files itself. The older log file has the suffix .bck.

To skip a rotation method, set the following flag to the executables to use (the default is rotatelogs,logrotate):

plugin_env_CLX_LOG_ROTATE_APP

Auto Discovery Updates

The UFM Telemetry auto discovery feature enables in-process topology updates, eliminating the need for process restarts.

External events trigger additional in-process ad-hoc discoveries and topology updates.

The following parameters configure the auto discovery updates feature:

Key

Type

Default Value

Description

plugin_env_CLX_EXPORT_API_ENABLE_AD_HOC_DISCOVERY

bool

1

Enable auto discovery updates

plugin_env_CLX_EXPORT_API_AD_HOC_DISCOVERY_WITH_IB_TRAP

bool

0

Enable triggering by an InfiniBand (IB) trap from the subnet manager (SM)

plugin_env_CLX_EXPORT_API_AD_HOC_DISCOVERY_WITH_MANAGER_IB_TRAP

bool

1

Enable triggering from telemetry manager (UTM)

plugin_env_CLX_EXPORT_API_AD_HOC_DISCOVERY_MIN_INTERVAL_SECONDS

int

180

Minimum interval, in seconds, between two consecutive ad-hoc discoveries

plugin_env_CLX_EXPORT_API_AD_HOC_DISCOVERY_WITH_CLX_RESTART

bool

0

Enable triggering by the clx restart file. When enabled, the existence of the file does not restart the process.

plugin_env_CLX_EXPORT_API_AD_HOC_DISCOVERY_PERIODIC

bool

0

Enable periodic triggering of ad-hoc discoveries

plugin_env_CLX_EXPORT_API_IB_TRAP_LID

int

-1

The local identifier (LID) of the SM. Relevant only when the SM IB trap is enabled. A value of -1 means the LID is taken automatically at run time.

Last updated: