RTI Connext Java API Version 7.7.0

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

Inheritance diagram for MonitoringQosPolicy:
QosPolicy

Public Attributes

boolean enable
 <<basic>> <<extension>> Enables the collection and distribution of telemetry data for an RTI Connext application using RTI Monitoring Library 2.0. More...
 
String application_name
 <<basic>> <<extension>> The name of the resource that represents this RTI Connext application. More...
 
MonitoringDistributionSettings distribution_settings
 <<extension>> Configures the distribution of telemetry data. More...
 
MonitoringTelemetryData telemetry_data
 <<extension>> Configures the telemetry data that will be distributed. More...
 
- Public Attributes inherited from QosPolicy
final QosPolicyId_t id
 The ID of this QoS policy. More...
 
final String policy_name
 The name of this QoS policy. 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

boolean 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 when the the rtimonitoring2 shared library is in the library search path.

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 com.rti.dds.infrastructure.true or com.rti.dds.infrastructure.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

String 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

MonitoringDistributionSettings distribution_settings

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

Categories
Mutable, Debuggability

◆ telemetry_data

MonitoringTelemetryData telemetry_data

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

Categories
Mutable, Debuggability