More clarification on 13802

This commit is contained in:
Nick Mathewson 2017-04-25 10:40:27 -04:00
parent cb8ac1f331
commit 6bf82a4910
2 changed files with 12 additions and 9 deletions

View File

@ -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.

View File

@ -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 ###