diff options
| -rw-r--r-- | changes/ticket13802 | 10 | ||||
| -rw-r--r-- | doc/HACKING/Tracing.md | 11 |
2 files changed, 12 insertions, 9 deletions
diff --git a/changes/ticket13802 b/changes/ticket13802 index 581d5bd744..35cd2b5b68 100644 --- a/changes/ticket13802 +++ b/changes/ticket13802 @@ -1,5 +1,7 @@ o Minor features (testing): - - Add general tracing instrumentation to Tor. For now, this subsystem is - not being used by any part of the code, it is for future use or external - testing that is not part of the upstream code base. Any tracing - framework needs to be enabled at compile time. Closes #13802. + - Add a general event-tracing instrumentation support to Tor. This + subsystem will enable developers and researchers to add fine-grained + instrumentation to their Tor instances, for use when examining Tor + network performance issues. There are no trace events yet, and + event-tracing is off by default unless enabled at compile time. + Implements ticket 13802. diff --git a/doc/HACKING/Tracing.md b/doc/HACKING/Tracing.md index f4a55b7e02..a5fb5165e2 100644 --- a/doc/HACKING/Tracing.md +++ b/doc/HACKING/Tracing.md @@ -1,13 +1,14 @@ # Tracing # -This document describes how the tracing subsystem works in tor so developers -can add events to the code base but also hook them to a tracing framework. +This document describes how the event tracing subsystem works in tor so +developers can add events to the code base but also hook them to an event +tracing framework. ## Basics ### -Tracing is seperated in two concepts, trace events and a tracer. The tracing -subsystem can be found in `src/trace`. The `events.h` header file is the -main file that maps the different tracers to trace events. +Event tracing is seperated in two concepts, trace events and a tracer. The +tracing subsystem can be found in `src/trace`. The `events.h` header file is +the main file that maps the different tracers to trace events. ### Events ### |