aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/stat/index.md
blob: 9bdceb559269eda5164499d8b2a6244fa0195701 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Statistics

To facilitate debugging and support situations, the _NNG_ library
supports collection and reporting of numerous statistics.

These statistics are organized in a tree, and include both values,
and metadata describing the statistics. In order to be efficient and
minimize the impact of maintaining statistics, an explicit snapshot
of statistics must be taken, and that snapshot can then be processed.

The following documentation will be useful:

- [nng_stat](./nng_stat.md) - Single statistic
- [nng_stats](./nng_stats.md) - Statistics snapshot

> [!NOTE]
> The presence, name, and semantics of any given statistic are
> subject to change at any time and without notice.
> Programmatic use is therefore discouraged.

> [!NOTE]
> Statistics may be disabled by build-time configuration options,
> in order to reduce program size and run-time overheads.