<<extension>> Configures the use of RTI Monitoring Library 2.0 to collect and distribute RTI Connext telemetry data. More...

Public Attributes
DDS_Boolean	enable
	<<basic>> <<extension>> Enables the collection and distribution of telemetry data for an RTI Connext application using RTI Monitoring Library 2.0. More...

char *	application_name
	<<basic>> <<extension>> The name of the resource that represents this RTI Connext application. More...

struct DDS_MonitoringDistributionSettings	distribution_settings
	<<extension>> Configures the distribution of telemetry data. More...

struct DDS_MonitoringTelemetryData	telemetry_data
	<<extension>> Configures the telemetry data that will be distributed. More...

Detailed Description

<<extension>> Configures the use of RTI Monitoring Library 2.0 to collect and distribute RTI Connext telemetry data.

Member Data Documentation

◆ enable

DDS_Boolean DDS_MonitoringQosPolicy::enable

<<basic>> <<extension>> Enables the collection and distribution of telemetry data for an RTI Connext application using RTI Monitoring Library 2.0.

RTI Monitoring Library 2.0 is automatically enabled under the following conditions:

For RTI Connext applications that link with the RTI Connext shared libraries as long as the rtimonitoring2 shared library is in the library search path. There is no need to link with rtimonitoring2.
For RTI Connext applications that link with the RTI Connext static libraries, including rtimonitoring2, as long as the application calls the API RTI_Monitoring_initialize.

RTI Monitoring Library 2.0 is not automatically enabled for RTI Connext RTI DDS Ping, RTI DDS Spy, RTI Monitor, RTI Admin Console nor RTI Observability Collector Service.

You can override the default behavior and control whether RTI Monitoring Library 2.0 is enabled or disabled in two ways in order of precedence:

Environment variable: Set RTI_MONITORING2_ENABLE to true or false. This is the simplest way to enable or disable the library without modifying your application or its configuration.
QoS policy: Set this field to DDS_BOOLEAN_TRUE or DDS_BOOLEAN_FALSE programmatically or via XML.

The environment variable should not be changed at runtime. If you need to enable or disable RTI Monitoring Library 2.0 at runtime, use this field instead.

Note: Enabling and disabling RTI Monitoring Library 2.0 while DDS Entities are being created or deleted is not a safe operation. The entities created while RTI Monitoring Library 2.0 is being enabled may not be monitored.

Categories: Mutable, Debuggability

◆ application_name

char* DDS_MonitoringQosPolicy::application_name

<<basic>> <<extension>> The name of the resource that represents this RTI Connext application.

When this member is set to a value other than NULL , the resource identifier representing this application will be:

/applications/<application_name>

This is the resource identifier that will be used to send commands to this application from the RTI Observability Dashboards.

The application_name should be unique across the RTI Connext system; however, RTI Monitoring Library 2.0 does not currently enforce uniqueness.

When this member is set to NULL , RTI Monitoring Library 2.0 will automatically assign a resource identifier with this format:

/applications/<host_name:process_id:uuid>

[default] NULL

Categories: Mutable, Debuggability

◆ distribution_settings

struct DDS_MonitoringDistributionSettings DDS_MonitoringQosPolicy::distribution_settings

<<extension>> Configures the distribution of telemetry data.

Categories: Mutable, Debuggability

◆ telemetry_data

struct DDS_MonitoringTelemetryData DDS_MonitoringQosPolicy::telemetry_data

<<extension>> Configures the telemetry data that will be distributed.