<<extension>> Configures event and periodic metrics collection and distribution for a specific set of observable resources. More...

#include <rti/core/PolicySettings.hpp>

Public Member Functions
	MonitoringMetricSelection ()=default
	Creates an instance with the default settings. More...

MonitoringMetricSelection &	resource_selection (const std::string &the_resource_selection)
	An expression pattern that selects a subset of resources by matching the pattern to the resource names. rti::core::MonitoringMetricSelection::enabled_metrics_selection and rti::core::MonitoringMetricSelection::disabled_metrics_selection are applied to this subset of resources. More...

std::string	resource_selection () const
	Getter (see setter with the same name). More...

MonitoringMetricSelection &	enabled_metrics_selection (const dds::core::StringSeq &the_enabled_metrics_selection)
	Sets 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 rti::core::MonitoringMetricSelection::resource_selection. More...

dds::core::StringSeq	enabled_metrics_selection () const
	Getter (see setter with the same name) More...

MonitoringMetricSelection &	disabled_metrics_selection (const dds::core::StringSeq &the_disabled_metrics_selection)
	Sets A sequence of POSIX fnmatch patterns that match the names of the metrics that should not be collected and distributed for the observable resources selected by rti::core::MonitoringMetricSelection::resource_selection. More...

dds::core::StringSeq	disabled_metrics_selection () const
	Getter (see setter with the same name) More...

Detailed Description

<<extension>> Configures event and periodic metrics collection and distribution for a specific set of observable resources.

Constructor & Destructor Documentation

◆ MonitoringMetricSelection()

rti::core::MonitoringMetricSelection::MonitoringMetricSelection ( )

default

Creates an instance with the default settings.

Member Function Documentation

◆ resource_selection() [1/2]

MonitoringMetricSelection & rti::core::MonitoringMetricSelection::resource_selection ( const std::string & the_resource_selection )

An expression pattern that selects a subset of resources by matching the pattern to the resource names. rti::core::MonitoringMetricSelection::enabled_metrics_selection and rti::core::MonitoringMetricSelection::disabled_metrics_selection are applied to this subset of resources.

Parameters

the_resource_selection A string.

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.

◆ resource_selection() [2/2]

std::string rti::core::MonitoringMetricSelection::resource_selection ( ) const

Getter (see setter with the same name).

◆ enabled_metrics_selection() [1/2]

MonitoringMetricSelection & rti::core::MonitoringMetricSelection::enabled_metrics_selection ( const dds::core::StringSeq & the_enabled_metrics_selection )

Sets 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 rti::core::MonitoringMetricSelection::resource_selection.

This sequence is evaluated first, followed by rti::core::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 (dds::core::policy::Durability::writer_depth). The second pattern refers to all the DataReader dds::core::policy::Reliability 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.

◆ enabled_metrics_selection() [2/2]

dds::core::StringSeq rti::core::MonitoringMetricSelection::enabled_metrics_selection ( ) const

Getter (see setter with the same name)

◆ disabled_metrics_selection() [1/2]

MonitoringMetricSelection & rti::core::MonitoringMetricSelection::disabled_metrics_selection ( const dds::core::StringSeq & the_disabled_metrics_selection )

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

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