Monitoring Library 2.0

RTI Monitoring Library 2.0 public API. More...

Functions
void	RTI_Monitoring_initialize (void)
	Initializes Monitoring Library 2.0. More...

Variables
const char *const	RTI_MONITORING_PERIODIC_TOPIC_NAME
	The name of the Monitoring Topic used for periodic metrics distribution. More...
const char *const	RTI_MONITORING_EVENT_TOPIC_NAME
	The name of the Monitoring Topic used for event metrics distribution. More...
const char *const	RTI_MONITORING_LOGGING_TOPIC_NAME
	The name of the Monitoring Topic used for log messages distribution. More...

Detailed Description

RTI Monitoring Library 2.0 public API.

RTI Monitoring Library 2.0 is one component of the RTI Connext Observability Framework which allows collecting and distributing telemetry data (metrics and logs) associated with the observable resources created by an RTI Connext application.

In this release, the only Observable resources are the following entities: DDS_DataWriter, DDS_DataReader, DDS_Publisher, DDS_Subscriber, DDS_DomainParticipant, DDS_Topic and Application (a process running RTI Connext).

The library also accepts remote commands to change the set of distributed telemetry data at run-time.

The data distributed by RTI Monitoring Library 2.0 is sent to an RTI Observability Collector Service instance, which forwards the data to other RTI Observability Collector Service instances or stores the data in third-party observability backends such as Prometheus or Grafana Loki.

RTI Monitoring Library 2.0 is a separate library (rtimonitoring2), and applications can use it in three different modes:

• Dynamically loaded: This is the default mode, and it requires that the rtimonitoring2 shared library is in the library search path.
• Dynamic linking: The application is linked with the rtimonitoring2 shared library.
• Static linking: The application is linked with the rtimonitoring2 static library.

The last two modes require calling the API RTI_Monitoring_initialize in your application before any other RTI Connext APIs. This API is defined in the header file ndds/monitoring/monitoring_monitoringClass.h.

Dynamic and static linking are only supported in C and C++ applications.

To enable use of RTI Monitoring Library 2.0 and configure its behavior, use the DDS_MonitoringQosPolicy QoS policy on the DDS_DomainParticipantFactory. This QoS policy can be configured programmatically or via XML.

Function Documentation

RTI_Monitoring_initialize()

void RTI_Monitoring_initialize

(

void

)

Initializes Monitoring Library 2.0.

This function must be called before calling any other RTI Connext API if the application links with RTI Monitoring Library 2.0 dynamically or statically.

Variable Documentation

RTI_MONITORING_PERIODIC_TOPIC_NAME

const char* const RTI_MONITORING_PERIODIC_TOPIC_NAME

The name of the Monitoring Topic used for periodic metrics distribution.

String version: "DCPSPeriodicStatusMonitoring".

This topic is used internally by Monitoring Library 2.0 and RTI Observability Collector Service. You should not publish or subscribe to it.

RTI_MONITORING_EVENT_TOPIC_NAME

const char* const RTI_MONITORING_EVENT_TOPIC_NAME

The name of the Monitoring Topic used for event metrics distribution.

String version: "DCPSEventStatusMonitoring".

This topic is used internally by Monitoring Library 2.0 and RTI Observability Collector Service. You should not publish or subscribe to it.

RTI_MONITORING_LOGGING_TOPIC_NAME

const char* const RTI_MONITORING_LOGGING_TOPIC_NAME

The name of the Monitoring Topic used for log messages distribution.

String version: "DCPSLoggingStatusMonitoring".

This topic is used internally by Monitoring Library 2.0 and RTI Observability Collector Service. You should not publish or subscribe to it.