No description
Find a file
Christophe Bedard 05781aa046 Merge branch '38-readme-invalid-status-executable' into 'master'
Resolve "README refers to invalid status executable"

Closes #38

See merge request micro-ROS/ros_tracing/ros2_tracing!75
2019-08-01 08:28:23 +00:00
doc Add space between ROS and 2 2019-07-01 11:08:00 +02:00
ros2trace Revert "Replace special character to fix encoding issue" 2019-08-01 08:51:30 +02:00
tracetools 0.2.1 2019-07-31 10:29:07 +02:00
tracetools_launch Revert "Replace special character to fix encoding issue" 2019-08-01 08:51:30 +02:00
tracetools_read Revert "Replace special character to fix encoding issue" 2019-08-01 08:51:30 +02:00
tracetools_test 0.2.1 2019-07-31 10:29:07 +02:00
tracetools_trace Revert "Replace special character to fix encoding issue" 2019-08-01 08:51:30 +02:00
.gitignore Resolve "Add option to compile out LTTng entirely" 2019-07-30 14:27:36 +00:00
.gitlab-ci.yml Check tracetools status in CI jobs 2019-07-25 11:15:13 +02:00
all.repos Update repo URLs after move to micro-ROS/ 2019-07-09 07:58:18 +00:00
instrumentation.repos Update repo URLs after move to micro-ROS/ 2019-07-09 07:58:18 +00:00
LICENSE Add license file 2019-06-18 08:53:46 +02:00
README.md Fix status executable name in README 2019-08-01 10:17:09 +02:00

tracetools

Tracing tools for ROS 2.

Building

If the TRACETOOLS_DISABLED option is enabled during build or if LTTng is not found, then this package will not do anything.

To enable tracing:

  1. Install LTTng with the Python bindings to control tracing and read traces:
    $ sudo apt-add-repository ppa:lttng/stable-2.10
    $ sudo apt-get update
    $ sudo apt-get install lttng-tools lttng-modules-dkms liblttng-ust-dev
    $ sudo apt-get install python3-babeltrace python3-lttng
    
    Note: the LTTng stable 2.10 PPA is used to get newer versions of the packages.
  2. Build
    $ colcon build
    
  3. Source and check that tracing is enabled:
    $ source ./install/local_setup.bash
    $ ros2 run tracetools status
    

Tracing

The steps above will not lead to trace data being generated, and thus they will have no impact on execution. LTTng has to be enabled. The packages in this repo provide two options.

Trace command

The first option is to use the ros2 trace command.

$ ros2 trace

By default, it will enable all ROS tracepoints and a few kernel tracepoints. The trace will be written to ~/.ros/tracing/session-YYYYMMDDHHMMSS. Run the command with -h for more information.

Launch file trace action

Another option is to use the Trace action in a launch file along with your Node action(s).

See this example launch file for more information.