Skip to content

Commit 214a2af

Browse files
Merge branch 'update-readme' into 'master'
Update LTTng version for docs links in README See merge request ros-tracing/ros2_tracing!294
2 parents e7f4b9b + d625efa commit 214a2af

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If LTTng is not found during build, or if the [`TRACETOOLS_DISABLED` option is e
5151

5252
To enable tracing:
5353

54-
1. Install [LTTng](https://lttng.org/docs/v2.11/) (`>=2.11.1`) with the Python bindings to control tracing and read traces:
54+
1. Install [LTTng](https://lttng.org/docs/v2.13/) (`>=2.11.1`) with the Python bindings to control tracing and read traces:
5555
```
5656
$ sudo apt-get update
5757
$ sudo apt-get install lttng-tools liblttng-ust-dev
@@ -62,7 +62,7 @@ To enable tracing:
6262
```
6363
$ sudo apt-get install lttng-modules-dkms
6464
```
65-
* For more information about LTTng, [see its documentation](https://lttng.org/docs/v2.11/).
65+
* For more information about LTTng, [see its documentation](https://lttng.org/docs/v2.13/).
6666
2. Build:
6767
* If you've already built ROS 2 from source before installing LTTng, you will need to re-build at least up to `tracetools`:
6868
```
@@ -103,7 +103,7 @@ The tracing directory can be configured using command/launch action parameters,
103103
* Use `$ROS_TRACE_DIR` if `ROS_TRACE_DIR` is set and not empty.
104104
* Otherwise, use `$ROS_HOME/tracing`, using `~/.ros` for `ROS_HOME` if not set or if empty.
105105
106-
Additionally, **if you're using kernel tracing with a non-root user, make sure that the [`tracing` group exists and that your user is added to it](https://lttng.org/docs/v2.11/#doc-tracing-group)**.
106+
Additionally, **if you're using kernel tracing with a non-root user, make sure that the [`tracing` group exists and that your user is added to it](https://lttng.org/docs/v2.13/#doc-tracing-group)**.
107107
108108
```
109109
# Create group if it doesn't exist
@@ -136,7 +136,7 @@ This way, tracing automatically starts when launching the launch file and ends w
136136
$ ros2 launch tracetools_launch example.launch.py
137137
```
138138
139-
The `Trace` action will also set the `LD_PRELOAD` environment to preload [LTTng's userspace tracing helper(s)](https://lttng.org/docs/#doc-prebuilt-ust-helpers) if the corresponding event(s) are enabled.
139+
The `Trace` action will also set the `LD_PRELOAD` environment to preload [LTTng's userspace tracing helper(s)](https://lttng.org/docs/v2.13/#doc-prebuilt-ust-helpers) if the corresponding event(s) are enabled.
140140
For more information, see [this example launch file](./tracetools_launch/launch/example.launch.py) and the [`Trace` action](./tracetools_launch/tracetools_launch/action.py).
141141
142142
You must [install the kernel tracer](#building) if you want to enable kernel events (`events_kernel` in Python, `events-kernel` in XML or YAML).
@@ -158,9 +158,9 @@ It is a low-overhead tracer with many important real-time compatible features:
158158
159159
However, some settings need to be tuned for it to be fully real-time safe and for performance to be optimal for your use-case:
160160
161-
* timers[^rt-1]: use [read timer](https://lttng.org/docs/v2.11/#doc-channel-read-timer) to avoid a write(2) call
161+
* timers[^rt-1]: use [read timer](https://lttng.org/docs/v2.13/#doc-channel-read-timer) to avoid a write(2) call
162162
* sub-buffer[^rt-1] count and size:
163-
* see [documentation](https://lttng.org/docs/v2.11/#doc-channel-subbuf-size-vs-subbuf-count) for sub-buffer count and size tuning tips based on your use-case
163+
* see [documentation](https://lttng.org/docs/v2.13/#doc-channel-subbuf-size-vs-subbuf-count) for sub-buffer count and size tuning tips based on your use-case
164164
* minimize sub-buffer count to minimize sub-buffer switching overhead
165165
* one-time memory allocation/lock/syscall per thread:
166166
* usually done the first time a tracepoint is executed within a thread for URCU thread registration, but registration can be manually performed to force it to be done during your application's initialization
@@ -170,7 +170,7 @@ However, some settings need to be tuned for it to be fully real-time safe and fo
170170
171171
For further reading:
172172
173-
* [LTTng documentation](https://lttng.org/docs/v2.11/)
173+
* [LTTng documentation](https://lttng.org/docs/v2.13/)
174174
* [Combined Tracing of the Kernel and Applications with LTTng](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.641.1965&rep=rep1&type=pdf#page=87): LTTng-UST architecture and design goals (section 3)
175175
* [Survey and Analysis of Kernel and Userspace Tracers on Linux: Design, Implementation, and Overhead](https://dl.acm.org/doi/abs/10.1145/3158644): LTTng-UST overhead and design compared to other kernel and userspace tracers (table 6: average latency overhead per tracepoint of 158 ns)
176176

0 commit comments

Comments
 (0)