Skip to content

Commit

Permalink
Change default logconsumer to StdoutErr (#790)
Browse files Browse the repository at this point in the history
* Refs #21098: Change default logconsumer to StdoutErr

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21098: Apply Miguels suggestion

Signed-off-by: Mario Dominguez <[email protected]>

* Refs #21098: Apply rev suggestion on installation

Signed-off-by: Mario Dominguez <[email protected]>

---------

Signed-off-by: Mario Dominguez <[email protected]>
  • Loading branch information
Mario-DL authored Jun 4, 2024
1 parent 5b88fd0 commit 93f6c19
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions docs/fastdds/logging/consumer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ StdoutConsumer

|StdoutConsumer-api| outputs log entries to STDOUT stream following the convection specified in
:ref:`dds_layer_log_logging_spec`.
It is the default and only log consumer of the logging module if the CMake option |LOG_CONSUMER_DEFAULT| is set to
``AUTO``, ``STDOUT``, or not set at all.
It is the default logging module if the CMake option |LOG_CONSUMER_DEFAULT| is set to ``STDOUT``.
It can be registered and unregistered using the methods explained in
:ref:`dds_layer_log_register_consumers` and :ref:`dds_layer_log_reset`.

Expand All @@ -42,6 +41,8 @@ StdoutErrConsumer
|StdoutErrConsumer-api| uses a |Log::Kind-api| threshold to filter the output of the log entries.
Those log entries whose |Log::Kind-api| is equal to or more severe than the given threshold output to STDERR.
Other log entries output to STDOUT.
It is the default and only log consumer of the logging module if the CMake option |LOG_CONSUMER_DEFAULT| is set to
``AUTO``, ``STDOUTERR``, or not set at all.
By default, the threshold is set to |Log::Kind::Warning-api|.
|StdoutErrConsumer::stderr_threshold-api| allows the user to modify the default threshold.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/configuration/cmake_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ This module can be configured using *Fast DDS* CMake arguments regarding the fol
- Default
* - :class:`LOG_CONSUMER_DEFAULT`
- Selects the default log consumer for the logging module. |br|
``AUTO`` has the same behavior as ``STDOUT``. |br|
``AUTO`` has the same behavior as ``STDOUTERR``. |br|
For more information, please refer to :ref:`Log consumers <dds_layer_log_consumer>`.
- ``AUTO`` ``STDOUT`` |br|
``STDOUTERR``
Expand Down

0 comments on commit 93f6c19

Please sign in to comment.