From d83b96faeb02d7a3574e63880141d6b23f31ced1 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 22 Aug 2018 08:56:53 -0700
Subject: fixes #4 Statistics support

This introduces new public APIs for obtaining statistics,
and adds some generic stats for dialers, listeners, pipes, and
sockets.  Also added are stats for inproc and pairv1 protocol.

The other protocols and transports will have stats added
incrementally as time goes on.

A simple test program, and man pages are provided for this.
Start by looking at nng_stat(5).

Statistics does have some impact, and they can be disabled by
using the advanced NNG_ENABLE_STATS (setting it to OFF, it's
ON by default) if you need to build a minimized configuration.
---
 docs/man/libnng.3.adoc | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'docs/man/libnng.3.adoc')

diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 3e3037f9..299b73ef 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -222,6 +222,25 @@ concurrent applications.
 |<<nng_ctx_setopt.3#,nng_ctx_setopt()>>|set context option
 |===
 
+=== Statistics
+
+The following functions provide access to statistics which can be used
+to observe program behaviors and as an aid in troubleshooting.
+
+|===
+|<<nng_stat_child.3#,nng_stat_child()>>|get child statistic
+|<<nng_stat_desc.3#,nng_stat_name()>>|get statistic description
+|<<nng_stat_name.3#,nng_stat_name()>>|get statistic name
+|<<nng_stat_next.3#,nng_stat_next()>>|get next statistic
+|<<nng_stat_string.3#,nng_stat_string()>>|get statistic string value
+|<<nng_stat_timestamp.3#,nng_stat_timestamp()>>|get statistic timestamp
+|<<nng_stat_type.3#,nng_stat_type()>>|get statistic type
+|<<nng_stat_unit.3#,nng_stat_unit()>>|get statistic unit
+|<<nng_stat_value.3#,nng_stat_valueg()>>|get statistic value
+|<<nng_stats_free.3#,nng_stats_free()>>|free statistics
+|<<nng_stats_get.3#,nng_stats_get()>>|get statistics
+|===
+
 === URL Object
 
 Common functionality is supplied for parsing and handling
-- 
cgit v1.2.3-70-g09d2

