diff --git a/docs/rst/figures/screenshots/domain_graph.png b/docs/rst/figures/screenshots/domain_graph.png new file mode 100644 index 00000000..655a86c1 Binary files /dev/null and b/docs/rst/figures/screenshots/domain_graph.png differ diff --git a/docs/rst/figures/screenshots/init-monitor.png b/docs/rst/figures/screenshots/init-monitor.png index 6715fe8d..bbd67f48 100644 Binary files a/docs/rst/figures/screenshots/init-monitor.png and b/docs/rst/figures/screenshots/init-monitor.png differ diff --git a/docs/rst/figures/screenshots/main_panel.png b/docs/rst/figures/screenshots/main_panel.png index 7ec439cb..bef014fc 100644 Binary files a/docs/rst/figures/screenshots/main_panel.png and b/docs/rst/figures/screenshots/main_panel.png differ diff --git a/docs/rst/figures/screenshots/problem.png b/docs/rst/figures/screenshots/problem.png new file mode 100644 index 00000000..3a137778 Binary files /dev/null and b/docs/rst/figures/screenshots/problem.png differ diff --git a/docs/rst/figures/screenshots/problem_detail.png b/docs/rst/figures/screenshots/problem_detail.png new file mode 100644 index 00000000..84a875f8 Binary files /dev/null and b/docs/rst/figures/screenshots/problem_detail.png differ diff --git a/docs/rst/figures/screenshots/shapes_domain.png b/docs/rst/figures/screenshots/shapes_domain.png new file mode 100644 index 00000000..dfe8e7d8 Binary files /dev/null and b/docs/rst/figures/screenshots/shapes_domain.png differ diff --git a/docs/rst/figures/screenshots/shapes_topic.png b/docs/rst/figures/screenshots/shapes_topic.png new file mode 100644 index 00000000..b3253e9b Binary files /dev/null and b/docs/rst/figures/screenshots/shapes_topic.png differ diff --git a/docs/rst/user_manual/chart_panel_index.rst b/docs/rst/user_manual/chart_panel_index.rst index 824ecdb3..21c813a7 100644 --- a/docs/rst/user_manual/chart_panel_index.rst +++ b/docs/rst/user_manual/chart_panel_index.rst @@ -7,13 +7,42 @@ Main Panel ########## -In the central panel or *chart panel*, is where the data of the entities will be displayed. -The main feature of the *Fast DDS Monitor* application is to graphically display the data that is being monitored. +In the central panel, there is a tab section that allows multiple views, including a collapsed menu that reports the +possible problems that have been detected on the DDS entities. + +The main feature of the *Fast DDS Monitor* application is to graphically display the data that is being monitored in +the *Chart View*. DDS entities have associated different types of data (so-called *DataKind*) that could be visualize by configuring a chart. For example, it can be displayed the mean, median and standard deviation latency between two machines (*Hosts*) running *Fast DDS* applications for the period of two hours in intervals of ten minutes. +The *Fast DDS Monitor* can also show the detected entities in a graph. +The *Domain view* would filter all entities that belong to the same DDS Domain, and represent the inheritance of the +physical and DDS entities (the DataWriters or DataReaders that belong to a DomainParticipant, the +DomainParticipants that run on the same process, the processes that a user is running, and the users that are on a +host). +Those relations are represented in different boxes that contain the sub-category of entities. +Also, the connections between different endpoints that are publishing or subscribed to a Topic are represented with +arrows. +Those arrows would start from the DataWriter and point to the Topic, or start from the Topic and point to the +DataReader (in publication and subscription cases, respectively). + +.. figure:: /rst/figures/screenshots/shapes_domain.png + :align: center + +If filtering that graph by Topic, only the entities whose endpoints are publishing in, or subscribed to the selected +Topic would be represented in the view. + +.. figure:: /rst/figures/screenshots/shapes_topic.png + :align: center + +If there are problems reported by a DDS entity, they are condensed by entity in the bottom layout problem section. +Among the problem counter, the problem is described and, in some cases, followed by a link to the documentation. + +.. figure:: /rst/figures/screenshots/problem_detail.png + :align: center + .. toctree:: :maxdepth: 2 diff --git a/docs/rst/user_manual/layout.rst b/docs/rst/user_manual/layout.rst index a5fd95db..919c33ab 100644 --- a/docs/rst/user_manual/layout.rst +++ b/docs/rst/user_manual/layout.rst @@ -219,9 +219,11 @@ For the explanation of this information refer to the section :ref:`log_panel`. Main Panel ========== -The central window it will display the data charts, so-called *Chartbox*, that the user has configured. -To create a new *Chartbox* go to *Edit->DisplayNewData* in the application menu. -This button will create a new *Chartbox* where new series could be added, removed or modified. +The central window allows multiple tabs for different views. +It is also displayed a collapsed menu with the possible problems that have been detected on the DDS entities. +It will display the data charts, so-called *Chartbox*, that the user has configured. +It will display a domain graph where the physical, logical and DDS entities from a domain are represented, +focusing on the connection between endpoints through the topics, and the entities physical inheritance. .. figure:: /rst/figures/screenshots/main_panel.png :align: center @@ -232,10 +234,13 @@ For further information about how to create a chart refer to the section :ref:`c Chartbox -------- -These windows in the central panel store some *series* or *data configurations* to show a specific data type for +These windows in the main panel store some *series* or *data configurations* to show a specific data type for one or several entities in a specified time interval and with different accumulative operations on the data. -These Chartbox could be moved along the main window. +To create a new *Chartbox* go to *Chart View* in the Main Panel default tab, and click on *Create new chart* button. +This button will create a new *Chartbox* where new series could be added, removed or modified. + +These Chartbox could be moved along the *Chart View* tab. In order to move one of this charts, press in the *Chartbox* title and grab the object to its new location inside the main panel. The rest of the *Chartboxes* will automatically rearrange when one of them is moved to a different position. @@ -243,10 +248,12 @@ The rest of the *Chartboxes* will automatically rearrange when one of them is mo .. figure:: /rst/figures/screenshots/chartbox.png :align: center +For further information about how to create a chart refer to the section :ref:`chart_panel`. + .. _create_new_series_layout: Create Series Dialog ------------------------- +^^^^^^^^^^^^^^^^^^^^ This Dialog will appear every time a new Chartbox is created, or adding a new series by the button in the Chartbox *Series->AddSeries*. @@ -262,3 +269,36 @@ This Dialog will appear every time a new Chartbox is created, or adding a new se For further details on how to configure a new series refer to :ref:`historic_series` for historic data or :ref:`dynamic_series` for dynamic data. + +.. _domain_graph: + +Domain View +----------- +This view in the main panel shows the connections between DataWriters and DataReaders that belong to the same +DDS Domain. +They are represented encapsulated inside their physical entities (see :ref:`entities` relationship), and with a +connection to the topic they are published and subscribed, respectively. + +.. figure:: /rst/figures/screenshots/domain_graph.png + :align: center + +By clicking on any entity, its detailed information is displayed in the :ref:`info_panel`. +Right click allows changing the alias of the entity, filter the problems to display only the selected entity's problems +and, in the case of topics, filtering the domain graph by topic so that only the entities related to the selected topic +are displayed. + +.. _problem_summary: + +Problem summary +--------------- + +This section that can be expanded and collapsed displays all the collected problems per entity. +Those problems are related to DataReader samples lost, incompatible QoS between endpoints, or DataWriter deadline missed +counter, for instance. + +The entities that have reported a problem would display a warning or an error icon close to the entity name, based on +the severity of the problem. +The entity representation in the domain graph may also display that icon. + +.. figure:: /rst/figures/screenshots/problem.png + :align: center