[sr-dev] git:master:e9b019e9: corex: documentation for corex.pkg_summary rpc command

Module: kamailio Branch: master Commit: e9b019e9f9e0c290ece5e025ac960ef88b741cf3 URL: https://github.com/kamailio/kamailio/commit/e9b019e9f9e0c290ece5e025ac960ef… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2015-10-12T00:28:00+02:00 corex: documentation for corex.pkg_summary rpc command --- Modified: modules/corex/README Modified: modules/corex/doc/corex_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/e9b019e9f9e0c290ece5e025ac960ef… Patch: https://github.com/kamailio/kamailio/commit/e9b019e9f9e0c290ece5e025ac960ef… --- diff --git a/modules/corex/README b/modules/corex/README index 6ed1d43..b06fb7e 100644 --- a/modules/corex/README +++ b/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] diff --git a/modules/corex/doc/corex_admin.xml b/modules/corex/doc/corex_admin.xml index 2a3c140..182ce5e 100644 --- a/modules/corex/doc/corex_admin.xml +++ b/modules/corex/doc/corex_admin.xml @@ -471,6 +471,28 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... } &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> <section>