mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-10 21:23:58 +01:00
doc: Initial documentation of the lib/metrics
Signed-off-by: David Goulet <dgoulet@torproject.org>
This commit is contained in:
parent
04ff22dc69
commit
1c06c9f1c0
12
src/lib/metrics/lib_metrics.md
Normal file
12
src/lib/metrics/lib_metrics.md
Normal file
@ -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.
|
Loading…
Reference in New Issue
Block a user