2
0
Эх сурвалжийг харах

corex: documentation for corex.pkg_summary rpc command

Daniel-Constantin Mierla 10 жил өмнө
parent
commit
e9b019e9f9

+ 16 - 0
modules/corex/README

@@ -55,6 +55,7 @@ Muhammad Shahzad Shafi
               5.2. corex.list_aliases
               5.3. corex.shm_status
               5.4. corex.shm_summary
+              5.5. corex.pkg_summary
 
         6. Event Routes
 
@@ -116,6 +117,7 @@ Chapter 1. Admin Guide
         5.2. corex.list_aliases
         5.3. corex.shm_status
         5.4. corex.shm_summary
+        5.5. corex.pkg_summary
 
    6. Event Routes
 
@@ -388,6 +390,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
    5.2. corex.list_aliases
    5.3. corex.shm_status
    5.4. corex.shm_summary
+   5.5. corex.pkg_summary
 
 5.1. corex.list_sockets
 
@@ -417,6 +420,19 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
    Example:
                 kamcmd corex.shm_summary
 
+5.5. corex.pkg_summary
+
+   Trigger pkg summary dump to syslog for a specific pid or process index.
+   It has two parameters: first to specify what matching type is desired
+   (can be 'pid' or 'idx'); second to specify the value for desired match.
+
+   The dump is happening when the selected process is doing a runtime
+   handling (e.g., processing a sip message).
+
+   Example:
+                kamcmd corex.pkg_summary pid 2345
+                kamcmd corex.pkg_summary idx 1
+
 6. Event Routes
 
    6.1. event_route[network:msg]

+ 22 - 0
modules/corex/doc/corex_admin.xml

@@ -470,6 +470,28 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
         <programlisting  format="linespecific">
 		&sercmd; corex.shm_summary
 		</programlisting>
+    </section>
+	<section>
+		<title>
+		<function moreinfo="none">corex.pkg_summary</function>
+		</title>
+		<para>
+			Trigger pkg summary dump to syslog for a specific pid or
+			process index. It has two parameters: first to specify what
+			matching type is desired (can be 'pid' or 'idx'); second to
+			specify the value for desired match.
+		</para>
+		<para>
+			The dump is happening when the selected process is doing a
+			runtime handling (e.g., processing a sip message).
+		</para>
+		<para>
+		Example:
+		</para>
+        <programlisting  format="linespecific">
+		&sercmd; corex.pkg_summary pid 2345
+		&sercmd; corex.pkg_summary idx 1
+		</programlisting>
     </section>
     </section>