Configures the distribution of event metrics. More...

Data Fields
DDS_UnsignedLong	concurrency_level
	Defines how concurrent the push of event metrics to RTI Monitoring Library 2.0 is. More...

char *	datawriter_qos_profile_name
	The fully qualified name of the profile used to configure the DDS_DataWriter that distributes event metrics. More...

struct DDS_ThreadSettings_t	thread
	The settings of the event metric thread. More...

struct DDS_Duration_t	publication_period
	Period at which the event metric thread publishes the event metrics that have changed since the last time they were published. More...

Detailed Description

Configures the distribution of event metrics.

Event metrics are provided to RTI Monitoring Library 2.0 when they change.

For example, if the liveliness of a DDS_DataWriter is lost, a matching DDS_DataReader will push the new value of DDS_LivelinessChangedStatus to RTI Monitoring Library 2.0 so that the liveliness status change can be distributed.

There are three kinds of event metrics:

Configuration metrics: Provided to RTI Monitoring Library 2.0 by pushing changes to QoS policies.
Status metrics: Provided to RTI Monitoring Library 2.0 by pushing changes to the event statuses such as DDS_LivelinessChangedStatus.
Resource metrics: Provided to RTI Monitoring Library 2.0 when a resource (such as DDS_DataWriter) is created or deleted.

The event metrics that will be distributed for an observable resource can be configured with DDS_MonitoringTelemetryData::metrics.

Field Documentation

◆ concurrency_level

DDS_UnsignedLong DDS_MonitoringEventDistributionSettings::concurrency_level

Defines how concurrent the push of event metrics to RTI Monitoring Library 2.0 is.

With a concurrency_level of one, all the event metrics pushed to RTI Monitoring Library 2.0 will be stored in a single queue protected by a single mutex.

With a concurrency_level of 'n', RTI Monitoring Library 2.0 will create 'n' queues for event metrics, each queue protected by its own mutex. Each resource (e.g, a DDS_DataReader) will be associated with one of the queues when the resource is registered with RTI Monitoring Library 2.0. Therefore, all the event metrics for a single resource always go to the same queue.

The event metrics for two resources associated with different event queues can be pushed in parallel. This is why a higher concurrency_level provides more concurrency.

The event metrics added to the event queues are processed by a single thread configured using DDS_MonitoringEventDistributionSettings::thread.

[default] 5

[range] [1, 100]

◆ datawriter_qos_profile_name

char* DDS_MonitoringEventDistributionSettings::datawriter_qos_profile_name

The fully qualified name of the profile used to configure the DDS_DataWriter that distributes event metrics.

The DDS_DataWriter Topic is RTI_MONITORING_EVENT_TOPIC_NAME.

If NULL (the default value), then RTI Monitoring Library 2.0 uses DDS_PROFILE_GENERIC_MONITORING2.

[default] NULL

◆ thread

struct DDS_ThreadSettings_t DDS_MonitoringEventDistributionSettings::thread

The settings of the event metric thread.

The event metric thread periodically publishes the event metrics pushed into RTI Monitoring Library 2.0 event metric queues after they change their values.

The thread runs at the period configured using DDS_MonitoringEventDistributionSettings::publication_period.

[default] DDS_THREAD_SETTINGS_DEFAULT

◆ publication_period

struct DDS_Duration_t DDS_MonitoringEventDistributionSettings::publication_period

Period at which the event metric thread publishes the event metrics that have changed since the last time they were published.

With a period of 0 seconds, changes to event metrics will be published immediately after they are pushed into RTI Monitoring Library 2.0.