Skip to content

Commit

Permalink
Refs #22575: Update explorer panel user guide
Browse files Browse the repository at this point in the history
Signed-off-by: Juanjo Garcia <[email protected]>
  • Loading branch information
juanjo4936 committed Jan 15, 2025
1 parent acf26d0 commit 9c905d6
Showing 1 changed file with 16 additions and 24 deletions.
40 changes: 16 additions & 24 deletions docs/rst/user_manual/explorer_panel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@
Explorer Panel
##############

The left sidebar shows the various entities that the application has knowledge about and their available information.
The left sidebar displays the various entities known to the application and their available information.
It is recommended to check the section :ref:`entities` in order to get a better approach on the kind of entities
that are displayed and the connection between them.
that are displayed and the connections between them.

.. _dds_panel:

DDS Panel
=========
In this panel are displayed all the :ref:`dds_entities` that has been discovered by the monitor so far under every
This panel displays all the :ref:`dds_entities` that have been discovered by the monitor so far under every
DDS domain or Discovery Server monitored.
This panel displays specific DDS entities related with the Fast DDS Monitor entity currently selected
(see :ref:`selected_entity`).
For example, it is possible to track the DDS entities created from an application running on a specific *Host*,
*User*, or *Process*, as well as the DDS entities that are working on a specific DDS domain or are publishing or
subscribed to a given topic.
subscribed to a given *Topic*.
Every entity in this panel is interactive:

- Clicking in the Participant name or the Participant icon will expand or collapse the list of DataWriters/DataReaders
Expand All @@ -47,14 +47,13 @@ Similar to the :ref:`dds_panel`, every entity in this panel is interactive:

Logical Panel
=============
This panel displays all the :ref:`logical_entities` that are being monitored.
he DDS domains that Fast DDS Monitor is monitoring are the ones set by the user (see :ref:`monitor_domain`)
and no new domains will or could be discovered apart from them since the Domains could not be discovered,
but known beforehand.
Therefore, this panel will only update the information.
This panel displays all the :ref:`logical_entities` being monitored.
The DDS domains moitored by Fast DDS Monitor those specified by the user (see :ref:`monitor_domain`).
No additional domains will or can be discovered beyond these, as domains cannot be dynamically discovered
and must be predefined. Therefore, this panel will only update the information.
For example, having enabled the monitoring of Domain X,
if an application using Fast DDS creates a new DomainParticipant in that domain with a DataWriter publishing in
Topic Y, the information of that topic will appear in this view listed under Domain X to which
Topic Y, the information of that topic will appear in this view listed under Domain X, to which
the DomainParticipant discovered by the monitor belongs.

Similar to the :ref:`dds_panel`, every entity in this panel is interactive:
Expand All @@ -68,7 +67,7 @@ Similar to the :ref:`dds_panel`, every entity in this panel is interactive:

Info Panel
==========
In this panel it is displayed the specific information of the entity that is currently **selected**
This panel displays the specific information of the entity that is currently **selected**
(see :ref:`selected_entity`).
This information has some fields that are general for all the entity kinds, and some others that depends on
the specific entity kind:
Expand All @@ -77,6 +76,11 @@ the specific entity kind:

* **name**: internal name of the entity
* **id**: internal unique id for each entity
* **kind**: kind of entity (e.g. host)
* **alive**: if the entity is alive or not
* **alias**: alias of the entity given by the user
* **metatraffic**: if the entity is processing metatraffic data or not
* **status**: status of the entity

* **Process**

Expand Down Expand Up @@ -106,7 +110,7 @@ the specific entity kind:

Statistics Panel
================
In this panel it is displayed a summary of some data types of the entity that is currently **selected**
This panel dispalys a summary of some data types of the entity that is currently **selected**
(see :ref:`selected_entity`).
Regarding the selected entity, the data will be fulfilled collecting all the data of all the entities related to the
this one.
Expand All @@ -122,12 +126,6 @@ The data displayed is the following:
* - Data Kind
- Statistic kind
- Description
* - `NETWORK_LATENCY`
- `MEDIAN`
- Median value of Network Latency |br|
* - `NETWORK_LATENCY`
- `STANDARD_DEVIATION`
- Standard deviation of Network Latency |br|
* - `FASTDDS_LATENCY`
- `MEDIAN`
- Median value of Application Latency |br|
Expand All @@ -146,12 +144,6 @@ The data displayed is the following:
* - `SUBSCRIPTION_THROUGHPUT`
- `STANDARD_DEVIATION`
- Standard deviation value of Subscription Throughput |br|
* - `RTPS_BYTES_SENT`
- `MEDIAN`
- Median value of Total Bytes sent in RTPS packages |br|
* - `RTPS_BYTES_LOST`
- `MEDIAN`
- Median value of Total Bytes lost in RTPS packages |br|
* - `RESENT_DATA`
- `MEAN`
- Mean value of Data packages that had to be resent |br|
Expand Down

0 comments on commit 9c905d6

Please sign in to comment.