Skip to content

Commit 532ab3e

Browse files
JLBuenoLopezJLBuenoLopez
authored
Bump to v0.8.0
* Refs #15958: bump version to v0.8.0 Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15958: add Fast DDS minimum version Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15958: update versions file Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15958: document new API extensions Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15958: v0.8.0 release notes Signed-off-by: JLBuenoLopez-eProsima <[email protected]> * Refs #15958: apply review suggestion Signed-off-by: JLBuenoLopez-eProsima <[email protected]> Signed-off-by: JLBuenoLopez-eProsima <[email protected]>
1 parent aa034d4 commit 532ab3e

File tree

8 files changed

+64
-15
lines changed

8 files changed

+64
-15
lines changed

‎CMakeLists.txt‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ string(TOUPPER "${PROJECT_NAME}" PROJECT_NAME_UPPER)
2626

2727
set(PROJECT_NAME_LARGE "Fast DDS Statistics Backend")
2828

29-
project(${PROJECT_NAME} VERSION 0.7.1
29+
project(${PROJECT_NAME} VERSION 0.8.0
3030
DESCRIPTION "eProsima ${PROJECT_NAME_LARGE} library provides a simple and easy-to-use API for interacting with data from Fast DDS statistics module")
3131

3232
set(${PROJECT_NAME}_DESCRIPTION_SUMMARY "C++ library for bridging Fast DDS statistics module data")
@@ -44,8 +44,10 @@ include(${PROJECT_SOURCE_DIR}/cmake/common/asan.cmake)
4444
###############################################################################
4545
# Load external projects.
4646
###############################################################################
47+
set(FASTDDS_MIN_VERSION "2.8.0")
48+
4749
find_package(fastcdr REQUIRED)
48-
find_package(fastrtps REQUIRED)
50+
find_package(fastrtps ${FASTDDS_MIN_VERSION} REQUIRED)
4951

5052
###############################################################################
5153
# Test system configuration

‎docs/code/StatisticsBackendTests.cpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,10 @@ void clear_examples()
143143
//CONF-CLEAR-EXAMPLE
144144
// Init a monitor in DDS domain 0 with no listener associated
145145
EntityId domain_monitor_id = StatisticsBackend::init_monitor(0);
146+
// Clear all statistics data
147+
StatisticsBackend::clear_statistics_data();
148+
// Clear inactive entities
149+
StatisticsBackend::clear_inactive_entities();
146150
// Stop the monitor
147151
StatisticsBackend::stop_monitor(domain_monitor_id);
148152
// Clear all data related to the monitor

‎docs/rst/exports/alias.include‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
.. |set_domain_listener-api| replace:: :cpp:func:`set_domain_listener()<eprosima::statistics_backend::StatisticsBackend::set_domain_listener>`
1717
.. |get_type-api| replace:: :cpp:func:`get_type()<eprosima::statistics_backend::StatisticsBackend::get_type>`
1818
.. |set_alias-api| replace:: :cpp:func:`set_alias()<eprosima::statistics_backend::StatisticsBackend::set_alias>`
19+
.. |clear_statistics_data-api| replace:: :cpp:func:`clear_statistics_data()<eprosima::statistics_backend::StatisticsBackend::clear_statistics_data>`
20+
.. |clear_inactive_entities-api| replace:: :cpp:func:`clear_inactive_entities()<eprosima::statistics_backend::StatisticsBackend::clear_inactive_entities>`
1921

2022
.. |DomainListener-api| replace:: :cpp:class:`DomainListener<eprosima::statistics_backend::DomainListener>`
2123
.. |DomainListener::on_data_available-api| replace:: :cpp:func:`on_data_available()<eprosima::statistics_backend::DomainListener::on_data_available>`

‎docs/rst/notes/notes.rst‎

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,36 @@
11
.. _release_notes:
22

3-
Version 0.7.1
3+
Version 0.8.0
44
=============
55

6-
This release adds the following **improvements**:
6+
This release includes the following **features**:
77

8-
* Update python dependencies for building the documentation
9-
* Re-generate Fast DDS-Gen generated TypeSupport with Fast DDS-Gen v2.2.0
10-
* Example to export ROS 2 statistics to Prometheus
8+
1. New API to clear statistic data and remove inactive entities from database.
9+
10+
This release includes the following **improvements**:
11+
12+
1. CI improvements:
13+
14+
1. Include address-sanitizer job.
15+
2. Flaky tests are run in a specific job.
16+
17+
1. Internal implementation improvements:
18+
19+
1. Remove database unused collections.
20+
2. Smart pointers refactor using unique instead of shared pointers.
21+
22+
1. Example:
23+
24+
1. Improve example including new API.
25+
26+
This release includes the following **bugfixes**:
27+
28+
1. Memory leaks fixes reported by address-sanitizer.
1129

1230
Previous versions
1331
=================
1432

33+
.. include:: previous_versions/v0.7.1.rst
1534
.. include:: previous_versions/v0.7.0.rst
1635
.. include:: previous_versions/v0.6.0.rst
1736
.. include:: previous_versions/v0.5.0.rst

‎docs/rst/notes/previous_versions/v0.7.1.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Version 0.7.1
2+
-------------
3+
4+
This release adds the following **improvements**:
5+
6+
* Update python dependencies for building the documentation
7+
* Re-generate Fast DDS-Gen generated TypeSupport with Fast DDS-Gen v2.2.0
8+
* Example to export ROS 2 statistics to Prometheus

‎docs/rst/statistics_backend/clear.rst‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@
22

33
.. _statistics_backend_clear:
44

5-
Clear all data related to a monitor
6-
-----------------------------------
5+
Clearing data
6+
-------------
7+
8+
*eProsima Fast DDS Statistics Backend* monitors both the entities discovered in a certain DDS domain or *Fast DDS*
9+
Discovery Server network, and the statistic data related to these entities.
10+
|StatisticsBackend-api| provides several methods to clear the data contained in the internal database:
11+
12+
* |clear_statistics_data-api| commands the deletion of all statistics data contained within the database.
13+
* |clear_inactive_entities-api| deletes from the database those :ref:`entities <types_entity_kind>` that are no longer
14+
alive and communicating (see :ref:`statistics_backend_is_active` for more information).
15+
* |clear_monitor-api| clears all data (entities and statistics) related to a specific monitor.
16+
To do so, the corresponding monitor needs to be stopped before the |clear_monitor-api| operation can be performed.
717

818
.. warning::
9-
This feature is currently not supported.
19+
|clear_monitor-api| is currently not supported.
1020
It will be implemented on a future release of *Fast DDS Statistics Backend*.
1121

12-
In case applications are no longer interested in statistical data of a given DDS domain or *Fast DDS* Discovery Server
13-
network, it is possible to delete said data completely.
14-
To do so, the corresponding monitor needs to be stopped before the |clear_monitor-api| operation can be performed.
15-
1622
.. literalinclude:: /code/StatisticsBackendTests.cpp
1723
:language: c++
1824
:start-after: //CONF-CLEAR-EXAMPLE

‎package.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<package format="3">
44
<name>fastdds_statistics_backend</name>
55
<!-->There must be a release. Update version accordingly<-->
6-
<version>0.7.1</version>
6+
<version>0.8.0</version>
77
<description>
88
C++ library to collect data from eProsima Fast DDS Statistics module and generate statistical information.
99
</description>

‎versions.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
Forthcoming
22
-----------
33

4+
Version 0.8.0
5+
-------------
6+
7+
This release has the following **API extensions**:
8+
9+
* `StatisticsBackend::clear_statistics_data` clears the statistics data from every entity.
10+
* `StatisticsBackend::clear_inactive_entities` removes every inactive entity from the database.
11+
412
Version 0.7.0
513
-------------
614

0 commit comments

Comments
 (0)