6.2. Resources

Observability Library collects telemetry data associated with observable resources. In this release, the observable resources are:

  • Application (one-to-one mapping to an OS process)

  • Participant

  • Topic

  • Publisher

  • Subscriber

  • DataWriter

  • DataReader

Each observable resource is identified by a GUID and a resource name. The GUID is automatically assigned by Observability Library, and it is globally unique across all the resources in the system (past and present). The resource GUID can be accessed using the guid label associated with each metric. See Metrics for detailed information about the metrics available in this release.

Table 6.1 lists details of each available resource. The resource names follow REST best practices for naming.

Table 6.1 Observable Resource Names

Resource

Resource Name

Dashboard Resource Name

How to Configure

Application

/applications/<AppName>

<AppName>

To set <AppName>, configure the participant_factory_qos.monitoring.application_name QoS policy field for an application. For more information, see MONITORING QosPolicy (DDS Extension)

Participant

/applications/<AppName>/domain_participants/<ParticipantName>

<AppName>/<ParticipantName>

To set <ParticipantName>, configure the participant_qos.participant_name.name QoS policy field for a Participant. For more information, see ENTITY NAME QosPolicy (DDS Extension)

Topic

/applications/<AppName>/domain_participants/<ParticipantName>/topics/<TopicName>

<TopicName>

<TopicName> is the name of the DDS Topic. This resource cannot be configured in the Monitoring QoS.

Publisher

/applications/<AppName>/domain_participants/<ParticipantName>/publishers/<PublisherName>

Dashboards do not show information about Publishers

To set <PublisherName>, configure the publisher_qos.publisher_name.name QoS policy field for a Publisher. For more information, see ENTITY NAME QosPolicy (DDS Extension)

Subscriber

/applications/<AppName>/domain_participants/<ParticipantName>/subscribers/<SubscriberName>

Dashboards do not show information about Subscribers

To set <SubscriberName>, configure the publisher_qos.subscriber_name.name QoS policy field for a Subscriber. For more information, see ENTITY NAME QosPolicy (DDS Extension)

DataWriter

/applications/<AppName>/domain_participants/<ParticipantName>/publishers/<PublisherName>/data_writers/<DataWriterName>

<AppName>/<ParticipantName>/<DataWriterName>

To set <DataWriterName>, configure the writer_qos.publication_name.name QoS policy field for a DataWriter. For more information, see ENTITY NAME QosPolicy (DDS Extension)

DataReader

/applications/<AppName>/domain_participants/<ParticipantName>/publishers/<PublisherName>/data_readers/<DataReaderName>

<AppName>/<ParticipantName>/<DataReaderName>

To set <DataReaderName>, configure the reader_qos.subscription_name.name QoS policy field for a DataReader. For more information, see ENTITY NAME QosPolicy (DDS Extension)

The Dashboard Resource Name column describes how resource names appear in RTI Connext Observability Dashboards. To generate shorter names, Observability Dashboards does not show the resource class name (e.g, domain_participants).

Important

Observability Framework does not enforce unique resource names. You are responsible for assigning unique names. When two observable resources have the same name, the commands targeting the resource name are applied to both resources. For example, if two applications have the same name and you change the logging verbosity from Observability Dashboards, the change will apply to both applications. Otherwise, not having unique names should not affect functionality because each resource has a unique GUID.