[sr-dev] git:master:ce027b03: statsc: documented statistics tracking

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: ce027b038a925fcdad8ec31c18c4432ffc7fca43
URL: https://github.com/kamailio/kamailio/commit/ce027b038a925fcdad8ec31c18c4432ffc7fca43

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-01-22T19:29:58+01:00

statsc: documented statistics tracking

---

Modified: modules/statsc/doc/statsc_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/ce027b038a925fcdad8ec31c18c4432ffc7fca43.diff
Patch: https://github.com/kamailio/kamailio/commit/ce027b038a925fcdad8ec31c18c4432ffc7fca43.patch

---

diff --git a/modules/statsc/doc/statsc_admin.xml b/modules/statsc/doc/statsc_admin.xml
index cc2d4d9..70124cc 100644
--- a/modules/statsc/doc/statsc_admin.xml
+++ b/modules/statsc/doc/statsc_admin.xml
@@ -95,6 +95,56 @@ modparam("statsc", "items", 200)
 </programlisting>
 		</example>
 	</section>
+	<section id="statsc.p.track">
+		<title><varname>track</varname> (str)</title>
+		<para>
+			Specify the statistics to track. The parameter can
+			be set many times and one value can speficy many
+			statistics.
+		</para>
+		<para>
+			The format is "rname=sname", where the rname is the
+			name for report and sname is internal &kamailio; statistic
+			name.
+		</para>
+		<para>
+			Next statistics are tracked by default:
+			<itemizedlist>
+			<listitem>
+			<para>
+				<emphasis>shm.free</emphasis> - the internal statistc 'free_size'
+				(from group 'shmem').
+			</para>
+			</listitem>
+			<listitem>
+			<para>
+				<emphasis>shm.used</emphasis> - the internal statistc 'used_size'
+				(from group 'shmem').
+			</para>
+			</listitem>
+			<listitem>
+			<para>
+				<emphasis>shm.real_used</emphasis> - the internal statistc 'real_used_size'
+				(from group 'shmem').
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+		<para>
+		<emphasis>
+			Default value is "".
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>track</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("statsc", "track", "req.received=rcv_requests")
+modparam("statsc", "track", "req.received=rcv_requests;rpl.received=rcv_replies")
+...
+</programlisting>
+		</example>
+	</section>
 	</section>
 
 	<section>