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 basic configurations of launch_ibdiagnet_config.ini are listed in the following table.

Section	Key	Type	Default Value	Description
`ibdiagnet`	`ibdiagnet_enabled`	bool	true	Enable/disable run 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	-	Frequency of collecting ports counters data
	`hca`	String	mlx5_2	Card to use. Can provide a comma-separated list of cards for local high availability
	`force_hca`	bool	false	Skip hca state check
	`app_name`	String	/opt/collectx/bin/ibdiagnet	Allow user to specify full path of the ibdiagnet application if necessary
	`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 used by ibdiagnet for data collection
`xdr`	`XDR`	bool	false	Needs to be enabled on XDR environment to configure additional required indexes
`Retention`	`retention_enabled`	bool	true	Enable/disable retention service
	`retention_interval`	time	1d	Interval to wait before running the retention process
	`retention_age`	time	100d	Period to reserve the collected data
`compression`	`compression_enable`	bool	true	Enable/disable 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

UFM telemetry log file “ibdiagnet2_port_counters.log” size is monitored by log rotation mechanism. This is highly relevant for cases of long execution time and/or high verbosity, where the number of logs can get excessively big.

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

Copy
Copied!

            
            plugin_env_CLX_LOG_ROTATE_ENABLED

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

Copy
Copied!

            
            plugin_env_CLX_LOG_ROTATE_NUM_FILES

To change the rotation’s threshold, set the following flag (default is 100M), use [K|M|G] as units:

Copy
Copied!

            
            plugin_env_CLX_LOG_ROTATE_SIZE

There are three optional rotation methods, used in the following order:

rotatelogs - If this executable exists, it will be used for logs rotation, and the rotated files name will differ by index suffix.
logrotate - If this executable exists, it will be used for logs rotation, and the rotated files name will differ by timestamp suffix.
manual rotation - In case both executables are not available, UFM telemetry will manually rotate 2 log files. The older log file will have “.bck”

To skip options, the following flag set the executables to use (default is “rotatelogs,logrotate”):

Copy
Copied!

            
            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.

This is achieved through additional in-process ad-hoc discoveries and topology updates triggered by external events.

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 IB Trap triggering from 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	Minimal interval between 2 consecutive ad-hoc discoveries (Seconds)
`plugin_env_CLX_EXPORT_API_AD_HOC_DISCOVERY_WITH_CLX_RESTART`	bool	0	Enable triggering from clx restart file (when enabled, process will not restart from the file existence)
`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 SM Link ID. Relevant only when SM IB trap is enabled. -1 Means the LID is taken automatically in runtime.

On This Page

Settings and Configuration

Log File Rotation

Auto Discovery Updates