diff options
| author | David Goulet <dgoulet@torproject.org> | 2020-10-22 15:11:58 -0400 |
|---|---|---|
| committer | David Goulet <dgoulet@torproject.org> | 2020-10-27 10:43:42 -0400 |
| commit | 1c06c9f1c0a496132a586ab8ff6ecf371b6ecf43 (patch) | |
| tree | a9fe12ef91bb1d9e75aad8329ab59af48b757559 /src/lib | |
| parent | 04ff22dc69496f8b05e9ef9ea3a0216ca5fec5be (diff) | |
| download | tor-1c06c9f1c0a496132a586ab8ff6ecf371b6ecf43.tar.gz tor-1c06c9f1c0a496132a586ab8ff6ecf371b6ecf43.zip | |
doc: Initial documentation of the lib/metrics
Signed-off-by: David Goulet <dgoulet@torproject.org>
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/metrics/lib_metrics.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/lib/metrics/lib_metrics.md b/src/lib/metrics/lib_metrics.md new file mode 100644 index 0000000000..e58680e237 --- /dev/null +++ b/src/lib/metrics/lib_metrics.md @@ -0,0 +1,12 @@ +@dir /lib/metrics +@brief lib/metrics: Metrics collection API + +This module is used for adding "metrics" support to Tor. + +Metrics are a collection of counters that are defined per-subsystem and +accessed through the MetricsPort. Each subsystem is responsible for populating +metrics store(s) and providing access to them through the `.get_metrics()` +call located in the `subsys_fns_t` object. + +These metrics are meant to be extremely lightweight and thus can be accessed +without too much CPU cost. |