Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pal-robotics/pal_statistics
A way of gathering, aggregating, storing and visualizing statistics from arbitrary sources in a flexible and real-time safe way in ROS/ROS2
https://github.com/pal-robotics/pal_statistics
introspection quantification-evaluation-methods real-time ros ros-control ros-controllers ros2 statistics
Last synced: 3 months ago
JSON representation
A way of gathering, aggregating, storing and visualizing statistics from arbitrary sources in a flexible and real-time safe way in ROS/ROS2
- Host: GitHub
- URL: https://github.com/pal-robotics/pal_statistics
- Owner: pal-robotics
- Created: 2018-06-28T14:19:00.000Z (over 6 years ago)
- Default Branch: humble-devel
- Last Pushed: 2024-06-18T10:02:00.000Z (5 months ago)
- Last Synced: 2024-06-18T11:25:08.569Z (5 months ago)
- Topics: introspection, quantification-evaluation-methods, real-time, ros, ros-control, ros-controllers, ros2, statistics
- Language: C++
- Homepage:
- Size: 3.38 MB
- Stars: 49
- Watchers: 11
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- awesome-ros-tools - pal_statistics - provides a way of gathering, aggregating, storing and visualizing statistics from arbitrary sources in a flexible and real-time safe way in ROS. From internal variables values to high level statistics about, but not limited to, robot performance. [pal_statistics Wiki](http://wiki.ros.org/pal_statistics). ![pal_statistics](https://img.shields.io/github/stars/pal-robotics/pal_statistics.svg?style=flat&label=Star&maxAge=86400) (Development Tools)
README
# PAL Statistics Framework
[![Build Status](https://travis-ci.org/pal-robotics/pal_statistics.svg?branch=kinetic-devel)](https://travis-ci.org/pal-robotics/pal_statistics)
The PAL Statistics Framework provides a way of gathering, aggregating, storing and visualizing statistics from arbitrary sources in a flexible and real-time safe way in ROS. From internal variables values to high level statistics about, but not limited to, robot performance.
## Data logging
To log a variable, it must be registered with a name to a topic.
Registering can be as easy as:
```
double my_variable = 3.0;
REGISTER_VARIABLE(node, "/statistics_topic", "my_variable_name", &my_variable);
```
To publish all variables registered to a topic:
```
PUBLISH_STATISTICS(node, "/statistics_topic");
```
And to unregister:
```
UNREGISTER_VARIABLE(node, "/statistics_topic", "my_variable_name");
```## Data transmission and storing
Data is sent via ROS topics of type [pal_statistics_msgs/Statistics](pal_statistics_msgs/msg/Statistics.msg) which basically is an array of names/doubles.
Data can be stored as rosbags, like all ros topics.
It's also designed to be integrated with [Graphite](https://graphiteapp.org/), which is:
>Graphite is an enterprise-ready monitoring tool that runs equally well on cheap hardware or Cloud infrastructure. Teams use Graphite to track the performance of their websites, applications, business services, and networked servers. It marked the start of a new generation of monitoring tools, making it easier than ever to store, retrieve, share, and visualize time-series data.## Data visualization
Data can be visualized with any tools that display ROS topics, but we recommend [PlotJuggler](https://github.com/facontidavide/PlotJuggler) for viewing high resolution live data, or data in bags.
![](imgs/plotjuggler.png)Or you can view historic data via [Grafana](https://grafana.com/)
![](imgs/grafana.png)## Tutorials
The tutorials for ROS are hosted on the [ROS wiki](http://wiki.ros.org/pal_statistics/Tutorials/Registering%20and%20publishing%20variables). In ROS 2 there are some changes, but it's similar. The node must be added as the first argument when using the macros.
## Acknowledgements
***Supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components.
More information: rosin-project.eu
This project has received funding from the European Union’s Horizon 2020
research and innovation programme under grant agreement no. 732287.