MonitoringMetricSelection Class Reference

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

Inherits Struct.

Public Member Functions
	MonitoringMetricSelection ()
	Constructor. More...
	MonitoringMetricSelection (MonitoringMetricSelection src)
	Copy constructor. More...

Public Attributes
String	resource_selection
	<<extension>> An expression pattern that selects a subset of resources by matching the pattern to the resource names. com.rti.dds.infrastructure.MonitoringMetricSelection.enabled_metrics_selection and com.rti.dds.infrastructure.MonitoringMetricSelection.disabled_metrics_selection are applied to this subset of resources. More...
StringSeq	enabled_metrics_selection
	<<extension>> 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 com.rti.dds.infrastructure.MonitoringMetricSelection.resource_selection. More...
StringSeq	disabled_metrics_selection
	<<extension>> 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 com.rti.dds.infrastructure.MonitoringMetricSelection.resource_selection. More...

Detailed Description

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

Constructor & Destructor Documentation

MonitoringMetricSelection() [1/2]

MonitoringMetricSelection

(

)

Constructor.

MonitoringMetricSelection() [2/2]

MonitoringMetricSelection

(

MonitoringMetricSelection

src

)

Copy constructor.

Parameters

src	<<in>> Source object.

References StringSeq.copy_from(), MonitoringMetricSelection.disabled_metrics_selection, MonitoringMetricSelection.enabled_metrics_selection, and MonitoringMetricSelection.resource_selection.

Member Data Documentation

resource_selection

String resource_selection

<<extension>> An expression pattern that selects a subset of resources by matching the pattern to the resource names. com.rti.dds.infrastructure.MonitoringMetricSelection.enabled_metrics_selection and com.rti.dds.infrastructure.MonitoringMetricSelection.disabled_metrics_selection are applied to this subset of resources.

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 name 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 the RTI Connext Observability Framework documentation for further information on the observable resource names and expression patterns.

Categories

Mutable, Debuggability

Referenced by MonitoringMetricSelection.MonitoringMetricSelection().

enabled_metrics_selection

StringSeq enabled_metrics_selection

<<extension>> 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 com.rti.dds.infrastructure.MonitoringMetricSelection.resource_selection.

This sequence is evaluated first, followed by com.rti.dds.infrastructure.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.

Examples of valid patterns:

• dds_data_writer_qos_durability_writer_depth
• dds_data_reader_qos_reliability_*
• dds_application_*

The first pattern refers to a specific DataWriter metric (com.rti.dds.infrastructure.DurabilityQosPolicy.writer_depth). The second pattern refers to all the DataReader com.rti.dds.infrastructure.ReliabilityQosPolicy metrics. The last pattern selects all the available application metrics.

See the Telemetry Data / Metrics chapter of the RTI Connext Observability Framework documentation for further information on the metric names and metric patterns.

Categories

Mutable, Debuggability

Referenced by MonitoringMetricSelection.MonitoringMetricSelection().

disabled_metrics_selection

StringSeq disabled_metrics_selection

<<extension>> 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 com.rti.dds.infrastructure.MonitoringMetricSelection.resource_selection.

This sequence is evaluated after com.rti.dds.infrastructure.MonitoringMetricSelection.enabled_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.

Examples of valid patterns:

• dds_data_writer_qos_durability_writer_depth
• dds_data_reader_qos_reliability_*
• dds_application_*

The first pattern refers to a specific DataWriter metric (com.rti.dds.infrastructure.DurabilityQosPolicy.writer_depth). The second pattern refers to all the DataReader com.rti.dds.infrastructure.ReliabilityQosPolicy metrics. The last pattern selects all the available application metrics.

See the Telemetry Data / Metrics chapter of the RTI Connext Observability Framework documentation for further information on the metric names and metric patterns.

Categories

Mutable, Debuggability

Referenced by MonitoringMetricSelection.MonitoringMetricSelection().