Skip to content

Commit

Permalink
Refs #13948: Add warning note stating that STATISTICS must be enabled…
Browse files Browse the repository at this point in the history
… for the Backend to collect data

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
  • Loading branch information
JLBuenoLopez committed Mar 24, 2022
1 parent 5c0f775 commit 0ee9fcf
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/rst/formalia/titlepage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,11 @@ generate statistical information to be used by applications.
This library is in the early stages of development.
For this reason, the API should not be considered stable, as API breaks may occur before the first official release.
Furthermore, several features may not be implemented yet.

.. warning::
Be aware that the statistics module is not compiled and used by default by *Fast DDS* but it has to be specifically
configured to send statistical data of an specific entity.
Therefore, *eProsima Fast DDS* library must be compiled with `FASTDDS_STATISTICS` CMake option enabled and use either
the `FASTDDS_STATISTICS` environment variable or the DomainParticipantQos to activate the statistics DataWriters.
For more information, please refer to the
`Statistics Module documentation <https://fast-dds.docs.eprosima.com/en/latest/fastdds/statistics/statistics.html#statistics-module>`_.

0 comments on commit 0ee9fcf

Please sign in to comment.