Browse Source

kex: doxumented pkg.stats rpc command

Daniel-Constantin Mierla 14 years ago
parent
commit
4288888487
2 changed files with 45 additions and 1 deletions
  1. 23 0
      modules_k/kex/README
  2. 22 1
      modules_k/kex/doc/kex_admin.xml

+ 23 - 0
modules_k/kex/README

@@ -48,6 +48,10 @@ Daniel-Constantin Mierla
               4.5. version
               4.6. which
 
+        5. RPC Commands
+
+              5.1. pkg.stats
+
    List of Examples
 
    1.1. setsflag usage
@@ -97,6 +101,10 @@ Chapter 1. Admin Guide
         4.5. version
         4.6. which
 
+   5. RPC Commands
+
+        5.1. pkg.stats
+
 1. Overview
 
    This module collects extensions from Kamailio core.
@@ -423,3 +431,18 @@ if(is_myself("$fu")) {
    MI FIFO Command Format:
                 :which:_reply_fifo_file_
                 _empty_line_
+
+5. RPC Commands
+
+   5.1. pkg.stats
+
+5.1.  pkg.stats
+
+   Print private memory (pkg) usage statistics per process. It can take an
+   optinal parameter that specifies the pid of process to print statistics
+   for. If pid parameter is not give, it prints statistics for all
+   processes.
+
+   Examples:
+                sercmd pkg.stats
+                sercmd pkg.stats 1234

+ 22 - 1
modules_k/kex/doc/kex_admin.xml

@@ -525,7 +525,28 @@ if(is_myself("$fu")) {
 		_empty_line_
 		</programlisting>
     </section>
-    </section>
+	</section>
 
+	<section>
+	<title>RPC Commands</title>
+	<section>
+		<title>
+		<function moreinfo="none">pkg.stats</function>
+		</title>
+		<para>
+			Print private memory (pkg) usage statistics per process. It
+			can take an optinal parameter that specifies the pid of process
+			to print statistics for. If pid parameter is not give, it prints
+			statistics for all processes.
+		</para>
+		<para>
+		Examples:
+		</para>
+        <programlisting  format="linespecific">
+		sercmd pkg.stats
+		sercmd pkg.stats 1234
+		</programlisting>
+    </section>
+    </section>
 </chapter>