41. Configuring Monitoring Library

This boolean value specifies whether or not Monitoring Library should collect CPU and memory usage statistics for the process in the topic rti/dds/monitoring/domainParticipantDescription.

This property is only applicable for platforms that support obtaining CPU and memory usage from monitoring data. CPU and memory usage is not available on these platforms: AIX, VxWorks, INTEGRITY, and LynxOS. On Solaris platforms, CPU usage is available, but memory usage is not.

CPU usage is reported in terms of time spent since the process has been started. It can be longer than the actual running time of the process on a multi-core machine.

Default: true if unspecified

To create a separate participant that will be used to publish monitoring information in the application, set this to the domain ID that you want to use for the newly created participant.

The new participant is created with the default Qos (for example, that defined in USER_QOS_PROFILES.xml), unless the qos_library and qos_profile properties are set.

Default: Not set (means you want to reuse the participant in your application that has monitoring turned on to publish statistics information for that participant)

Period of time to sample and publish all monitoring topics, in units of seconds.

Default: 5 if unspecified

Priority of the thread used to sample and publish monitoring data.

This value is architecture dependent.

Default if unspecified: same as the default used in Connext DDS for the event thread:

Windows systems: -2

Linux systems: -999999 (meaning use OS-default priority)

Stack size used for the thread that samples and publishes monitoring data. This value is architecture dependent.

Default if unspecified: same as the default used in Connext DDS for the event thread:

Windows systems: 0 (meaning use the default size for the executable).

Linux systems: -1 (meaning use OS’s default value).

Describes the type of thread.

Supported values (may be combined with by OR’ing with ‘|’ as seen in the default below):

• FLOATING_POINT: Code executed within the thread may perform floating point operations
• STDIO: Code executed within the thread may access standard
• I/O REALTIME_PRIORITY: The thread will be scheduled on a real-time basis
• PRIORITY_ENFORCE: Strictly enforce this thread's priority

Default: FLOATING_POINT|STDIO (same as the default used in Connext DDS for the event thread)

Specifies the name of the QoS library that will be used to create the monitoring library DomainParticipant, Publisher, and DataWriters.

Default: Not set. If you don't set this property, the entities are created with the following QoS values:

• The DomainParticipant uses the default DomainParticipantQos (for example, that defined in USER_QOS_PROFILES.xml).
• The Publisher and the DataWriters use a specific QoS configuration that can be found in the library RTIMonitoringQosLibrary in <path to examples>/connext_dds/qos/MONITORING_LIBRARY_QOS_PROFILES.xml. (Note that the Publisher and DataWriters use the values reproduced in this .xml file, but modifying the file has no effect; it is for reference only.)

Specifies the name of the QoS profile that will be used to create the monitoring library DomainParticipant, Publisher, and DataWriters.

Default: Not set. If you don't set this property, the entities are created with the following QoS values:

• The DomainParticipant uses the default DomainParticipantQos (for example, that defined in USER_QOS_PROFILES.xml).
• The Publisher and the DataWriters use a specific QoS configuration that can be found in the library RTIMonitoringQosLibrary in <path to examples>/connext_dds/qos/MONITORING_LIBRARY_QOS_PROFILES.xml. (Note that the Publisher and DataWriters use the values reproduced in this .xml file, but modifying the file has no effect; it is for reference only.)

Monitoring Library obtains all statuses of all entities in the Connext DDS application. This boolean value controls whether or not the change counts in those statuses are reset by Monitoring Library.

If set to true, the change counts are reset each time Monitoring Library is done accessing them.

If set to false, the change counts truly reflect what users will see in their application and are unaffected by the access of the monitoring library.

Default: false

This boolean value controls whether or not the entities created internally by Monitoring Library should be included in the entity counts published by the participant entity statistics topic.

If set to true, the internal monitoring entities will not be included in the count. (Thirteen internal writers are created by the monitoring library by default.)

Default: true

If set to true, DomainParticipant PropertyQosPolicy name and value pairs will not be sent out through the domainParticipantDescriptionTopic. This is necessary if you are linking with Monitoring Library and any of these conditions occur:

• The PropertyQosPolicy of a DomainParticipant has more than 32 properties.
• Any of the properties in PropertyQosPolicy of a DomainParticipant has a name longer than 127 characters or a value longer than 511 characters.

Default: false if unspecified

If set to true, DataReader PropertyQosPolicy name and value pairs will not be sent out through the dataReaderDescriptionTopic. This is necessary if you are linking with Monitoring Library and any of these conditions occur:

• The PropertyQosPolicy of a DataReader has more than 32 properties.
• Any of the properties in PropertyQosPolicy of a DataReader has a name longer than 127 characters or a value longer than 511 characters.

Default: false if unspecified

If set to true, DataWriter PropertyQosPolicy name and value pairs will not be sent out through the dataWriterDescriptionTopic. This is necessary if you are linking with Monitoring Library and any of these conditions occur:

• The PropertyQosPolicy of a DataWriter has more than 32 properties.
• Any of the properties in PropertyQosPolicy of a DataWriter has a name longer than 127 characters or a value longer than 511 characters.

Default: false if unspecified

Filter for monitoring topics, with regular expression matching syntax as specified in the Connext DDS documentation (similar to the POSIX fnmatch syntax). For example, if you only want to send description topics and the entity statistics topics, but NOT the matching statistics topics, you can specify “*Description,*EntityStatistics”.

Default: * if unspecified

Filter for user topics, with regular expression matching syntax as specified in the Connext DDS documentation (similar to the POSIX fnmatch syntax). For example, if you only want to send monitoring information for reader/writer/topic entities for topics that start with Foo or Bar, you can specify “Foo*,Bar*”.

Default: * if unspecified

Sets the verbosity on the monitoring library for debugging purposes (does not affect the topic/data that is sent out).

• -1: Silent
• 0: Exceptions only
• 1: Warnings
• 2 and up: Higher verbosity level

Default: 1 if unspecified