From 258be60e624f7959c2167e11cd65064c960950cc Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Thu, 8 Aug 2019 15:26:31 +0200 Subject: [PATCH] Add brief tool packages descriptions --- doc/design_ros_2.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/design_ros_2.md b/doc/design_ros_2.md index 67c2647..b0445be 100644 --- a/doc/design_ros_2.md +++ b/doc/design_ros_2.md @@ -551,6 +551,33 @@ We could look into making analyses work on both ROS 1 and ROS 2, through a commo ## Tools +* `tracetools_trace` + * wraps the LTTng Python bindings to setup and start a tracing session + * exposes simplified setup functions with default values + * provides an example `trace` entrypoint for tracing + ```shell + $ ros2 run tracetools_trace trace + ``` +* `ros2trace` + * provides a `ros2cli` extension + * uses `tracetools_trace` functions +* `tracetools_launch` + * provides a `Trace` action for `launch` + * uses `tracetools_trace` functions +* `tracetools_read` + * wraps the `babeltrace` Python bindings to read CTF traces +* `tracetools_test` + * provides a `TraceTestCase` class extending `unittest.TestCase` + * uses the `Trace` action with `launch` to trace the test nodes + * provides utility functions (e.g. assertion) + +* `tracetools_analysis` + * uses `tracetools_read` to read traces + * provides utilities to: + * convert CTF traces to pickle files + * wrap trace events in a Python `dict` + * handle and process trace events to gather data + ## Analysis architecture With profiling as an example implementation.