This data structure is used to configure event and periodic metrics collection and distribution for a specific set of observable resources. More...

Public Attributes
char *	resource_selection
	An expression pattern used to match the resource names of observable resources to which the configured metrics through DDS_MonitoringMetricSelection::enabled_metrics_selection and DDS_MonitoringMetricSelection::disabled_metrics_selection apply. More...

struct DDS_StringSeq	enabled_metrics_selection
	A sequence of POSIX fnmatch patterns that match the names of the metrics that should be collected and distributed for the observable resources selected by DDS_MonitoringMetricSelection::resource_selection. More...

struct DDS_StringSeq	disabled_metrics_selection
	A sequence of POSIX fnmatch patterns that mach the names of the metrics that should not be collected and distributed for the observable resources selected by DDS_MonitoringMetricSelection::resource_selection. More...

Detailed Description

This data structure is used to configure event and periodic metrics collection and distribution for a specific set of observable resources.

[Not supported.]

Member Data Documentation

◆ resource_selection

char* DDS_MonitoringMetricSelection::resource_selection

An expression pattern used to match the resource names of observable resources to which the configured metrics through DDS_MonitoringMetricSelection::enabled_metrics_selection and DDS_MonitoringMetricSelection::disabled_metrics_selection apply.

Following there are some examples of resource expression patterns:

/applications/myApp/domain_participants/myParticipant
/applications/*/domain_participants/*/subscribers/*
/applications/myApp/domain_participants/GUID(1234.5678.4321.8765)
//myEntity

The first expression refers to a DomainParticipant named "myParticipant" that belongs to an application named "myApp". The second expression applies to all the Subscribers in the system (resource names wildcards follow the POSIX fnmatch syntax). The third expression refers to a DomainParticipant with a specific resource GUID in the "myApp" application. The last expression uses the XPath "//" operator. It matches observable resources named "myEntity" no matter where they are located in the resource hieararchy.

See the Telemetry Data / Resources chapter of RTI Connext Observability Framework documentation for further information on the observable resource names and expression patterns.

◆ enabled_metrics_selection

struct DDS_StringSeq DDS_MonitoringMetricSelection::enabled_metrics_selection

A sequence of POSIX fnmatch patterns that match the names of the metrics that should be collected and distributed for the observable resources selected by DDS_MonitoringMetricSelection::resource_selection.

This sequence is evaluated first, followed by DDS_MonitoringMetricSelection::disabled_metrics_selection. Therefore, if the same metric is enabled and disabled at the same time, the disablement will be the final result.

The patterns in the sequence are evaluated in order.

Some examples of valid patterns are:

dds.data_writer.qos.durability.writer_depth
dds.data_reader.qos.reliability.*
dds.application.*

The first pattern refers to a specific DataWriter metric (DDS_DurabilityQosPolicy::writer_depth). The second pattern refers to all the DataReader DDS_ReliabilityQosPolicy metrics. The last pattern selects all the available application metrics.

See the Telemetry Data / Metrics chapter of RTI Connext Observability Framework documentation for further information on the metric names and metric patterns. The metric names to which the patterns apply are the "Backend Independent Metric Names" listed in the same chapter.

◆ disabled_metrics_selection

struct DDS_StringSeq DDS_MonitoringMetricSelection::disabled_metrics_selection

A sequence of POSIX fnmatch patterns that mach the names of the metrics that should not be collected and distributed for the observable resources selected by DDS_MonitoringMetricSelection::resource_selection.

This sequence is evaluated after DDS_MonitoringMetricSelection::enabled_metrics_selection. Therefore, if the same metric is enabled and disabled at the same time, the disablement will be the final result.