[sr-dev] git:master:c005354f: dialog: docs for rpc command dlg.stats_active

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-07-13T12:25:05+02:00

dialog: docs for rpc command dlg.stats_active

---

Modified: src/modules/dialog/doc/dialog_admin.xml

---

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

---

diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml
index 6d936491cb..18a0e9b0a8 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -2603,6 +2603,45 @@ if(has_totag()) {
 		</section>
 	</section>
 
+		<section id="dlg.r.stats_active">
+		<title>dlg.stats_active</title>
+		<para>
+			Get stats about active dialogs by scanning internal list of dialogs
+			(not relying on core stats framework).
+		</para>
+		<para>Name: <emphasis>dlg.stats_active</emphasis></para>
+		<para>Parameters: none.</para>
+		<para>Returned fields</para>
+		<itemizedlist>
+			<listitem><para>
+				<emphasis>starting</emphasis> - initial INVITE has been processed,
+				no ringing or 1xx has been received.
+			</para></listitem>
+			<listitem><para>
+				<emphasis>connecting</emphasis> - initial INVITE was forwarded
+				and rining or 1xx has been received.
+			</para></listitem>
+			<listitem><para>
+				<emphasis>answering</emphasis> - initial INVITE received 200ok,
+				but ACK was not handled yet.
+			</para></listitem>
+			<listitem><para>
+				<emphasis>ongoing</emphasis> - ongoing active dialog, after the
+				ACK was processed.
+			</para></listitem>
+			<listitem><para>
+				<emphasis>all</emphasis> - all active dialogs, respectively the
+				sum of the above values.
+			</para></listitem>
+		</itemizedlist>
+		<para>RPC Command Format:</para>
+		<programlisting  format="linespecific">
+...
+&kamcmd; dlg.stats_active
+...
+		</programlisting>
+		</section>
+	</section>
 
 	<section>
 	<title>Exported Variables</title>