doc: Initial documentation of the lib/metrics

Signed-off-by: David Goulet <dgoulet@torproject.org>
This commit is contained in:
David Goulet 2020-10-22 15:11:58 -04:00
parent 04ff22dc69
commit 1c06c9f1c0

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