Update documentation and release notes

Signed-off-by: Lucia Echevarria <[email protected]>
eProsima · Mar 1, 2024 · 6f23418 · 6f23418
1 parent c4f712f
commit 6f23418
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 2 deletions.
diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst
@@ -6,3 +6,7 @@
 ###################
 Forthcoming Version
 ###################
+
+This release will include the following **DDS Spy tool configuration features**:
+
+* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.
diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst
@@ -2,8 +2,7 @@
 
 .. _notes:
 
-.. TODO uncomment when there are forthcoming notes
-.. .. include:: forthcoming_version.rst
+.. include:: forthcoming_version.rst
 
 ##############
 Version v0.3.0

diff --git a/docs/rst/user_manual/configuration.rst b/docs/rst/user_manual/configuration.rst
@@ -288,6 +288,54 @@ QoS
 
     The :ref:`Topic QoS <user_manual_configuration_dds__topic_qos>` configured in ``specs`` can be overwritten by the :ref:`Manual Topics <user_manual_configuration_dds__manual_topics>`.
 
+.. _spy_specs_logging:
+
+Logging
+-------
+
+``specs`` supports a ``logging`` **optional** tag to configure the |spy| logs.
+Under the ``logging`` tag, users can configure the type of logs to display and filter the logs based on their content and category.
+When configuring the verbosity to ``info``, all types of logs, including informational messages, warnings, and errors, will be displayed.
+Conversely, setting it to ``warning`` will only show warnings and errors, while choosing ``error`` will exclusively display errors.
+
+.. code-block:: yaml
+
+    logging:
+      verbosity: info
+      filter:
+        error: "DDSPIPE|FASTDDSSPY"
+        warning: "DDSPIPE|FASTDDSSPY"
+        info: "FASTDDSSPY"
+
+.. note::
+
+    Configuring the logs via the Command-Line is still active and takes precedence over YAML configuration when both methods are used simultaneously.
+
+.. list-table::
+    :header-rows: 1
+
+    *   - Logging
+        - Yaml tag
+        - Description
+        - Data type
+        - Default value
+        - Possible values
+
+    *   - Verbosity
+        - ``verbosity``
+        - Show messages of equal |br|
+          or higher importance.
+        - *enum*
+        - ``warning``
+        - ``info`` / ``warning`` / ``error``
+
+    *   - Filter
+        - ``filter``
+        - Regex string as filter.
+        - String
+        - ``DDSPIPE`` / ``FASTDDSSPY``
+        - Regex category or content
+
 .. _user_manual_configuration_default:
 
 Default Configuration
@@ -334,3 +382,10 @@ This is a YAML file that uses all supported configurations and set them as defau
         history-depth: 5000
         max-rx-rate: 10
         downsampling: 2
+
+      logging:
+        verbosity: info
+        filter:
+          error: "DDSPIPE|FASTDDSSPY"
+          warning: "DDSPIPE|FASTDDSSPY"
+          info: "FASTDDSSPY"