aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/stat/index.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-15 20:31:04 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-15 20:31:04 -0700
commit4c83442e174b186f5ee22bc8744cc7cc2a890e13 (patch)
tree515c5c1b9be97cf876b32bd5359f88ecc7e1aa8a /docs/ref/api/stat/index.md
parentcc13903167e540c0e306ed7faa0b58a8bcd12066 (diff)
downloadnng-4c83442e174b186f5ee22bc8744cc7cc2a890e13.tar.gz
nng-4c83442e174b186f5ee22bc8744cc7cc2a890e13.tar.bz2
nng-4c83442e174b186f5ee22bc8744cc7cc2a890e13.zip
Stats API converted to mdbook.
A number of small errors were fixed, and we tried to restructure this to be a bit more usable to readers.
Diffstat (limited to 'docs/ref/api/stat/index.md')
-rw-r--r--docs/ref/api/stat/index.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/ref/api/stat/index.md b/docs/ref/api/stat/index.md
new file mode 100644
index 00000000..9bdceb55
--- /dev/null
+++ b/docs/ref/api/stat/index.md
@@ -0,0 +1,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.