niklas/tracetools_analysis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve readme with command examples and analysis steps

Browse source
This commit is contained in:
Christophe Bedard 2019-10-13 15:30:29 -07:00
parent 7c95336551
commit 2bf8aedac4
1 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -2,16 +2,30 @@
Analysis tools for [ROS 2 tracing](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing). Analysis tools for [ROS 2 tracing](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing).
# Setup ## Setup
To display results, install: To display results, install:
* [Jupyter](https://jupyter.org/install) * [Jupyter](https://jupyter.org/install)
* [Bokeh](https://bokeh.pydata.org/en/latest/docs/user_guide/quickstart.html#userguide-quickstart-install) * [Bokeh](https://bokeh.pydata.org/en/latest/docs/user_guide/quickstart.html#userguide-quickstart-install)
# Use ## Trace analysis
Start Jupyter Notebook: After generating a trace (see [`ros2_tracing`](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing#tracing)), we can analyze it to extract useful execution data.
Since CTF traces (the output format of the [LTTng](https://lttng.org/) tracer) are very slow to read, we first convert them into a single file which can be read much faster.
```
$ ros2 trace-analysis convert /path/to/trace/directory
```
Then we can process it to create a data model which could be queried for analysis.
```
$ ros2 trace-analysis process /path/to/trace/directory
```
This last command will process and output the raw data models, but to actually display results, process and analyze using a Jupyter Notebook.
``` ```
$ jupyter notebook $ jupyter notebook