Fast DDS Statistics Backend

eProsima Fast DDS Statistics Backend is a C++ library that provides collection and procession the statistics measurements reported by Fast DDS Statistics Module. The Backend provides a easy-to-use and user friendly API that abstracts the details of receiving and processing Fast DDS statistical data, so that applications can focus on providing great user experiences. Fast DDS Statistics Backend allows for:

• Monitoring the various aspects reported by the Statistics Module for as many DDS Domains and Fast DDS Discovery Server network as desired.
• Retrieve the DDS network graph.
• Retrieve QoS settings about the DDS entities deployed in the network.
• Receive notification on statistics updates for various events using a listener-callback mechanism.
• Check whether an entity is active.
• Retrieve statistics on all the aspects of the communication reported by the Fast DDS Statistics Module, with the possibility of specifying time windows, bins, and different statistics to apply.

Commercial support

Looking for commercial support? Write us to info@eprosima.com

Find more about us at eProsima’s webpage.

Installation guide

This tutorial shows how to build and install Fast DDS Statistics Backend using colcon, a command line tool to build sets of software packages. To do so, colcon and vcstool need to be installed:

pip install -U colcon-common-extensions vcstool

Dependencies

Fast DDS Statistics Backend depends on Fast DDS and Fast CDR. For simplicity, this tutorial will build these dependencies alongside the backend. More advanced users can build or link to this packages separately. Install Fast DDS dependencies running:

sudo apt update
sudo apt install -y \
    libasio-dev \
    libtinyxml2-dev

Build and install

# Change directory to the location where the colcon workspace will be created
cd <path_to_ws>
# Create workspace directory
mkdir -p fastdds_statistics_backend_ws/src
cd fastdds_statistics_backend_ws
# Get workspace setup file
wget https://raw.githubusercontent.com/eProsima/Fast-DDS-statistics-backend/main/fastdds_statistics_backend.repos
# Get build options file
wget https://raw.githubusercontent.com/eProsima/Fast-DDS-statistics-backend/main/colcon.meta
# Download repositories
vcs import src < fastdds_statistics_backend.repos
# Build the workspace
colcon build

Build and install documentation

Fast DDS Statistics Backend Documentation is generated using Sphinx.

Dependencies

Before being able to build the documentation, some dependencies need to be installed:

sudo apt update
sudo apt install -y \
    doxygen \
    python3 \
    python3-pip \
    python3-venv \
    python3-sphinxcontrib.spelling \
    imagemagick

Virtual environment

This tutorial will create a python3 virtual environment to avoid polluting user’s python installation.

```bash

Change directory to the root of the colcon workspace

cd /fastdds_statistics_backend_ws

Create a python3 virtual environment

python3 -m venv fastdds_statistics_backend_venv

File truncated at 100 lines see the full file