[sr-dev] git:master: kex: documented mi statistics commands

Module: sip-router Branch: master Commit: 6b7a27e81cc838de6af9a1c55edb937d1094ce98 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=6b7a27e… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue Sep 11 08:52:53 2012 +0200 kex: documented mi statistics commands - reported by David at lublink --- modules_k/kex/README | 51 +++++++++++++++++++++++++++++ modules_k/kex/doc/kex_admin.xml | 67 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 118 insertions(+), 0 deletions(-) diff --git a/modules_k/kex/README b/modules_k/kex/README index 89b3197..d7b35ee 100644 --- a/modules_k/kex/README +++ b/modules_k/kex/README @@ -49,6 +49,9 @@ Daniel-Constantin Mierla 4.4. uptime 4.5. version 4.6. which + 4.7. get_statistics + 4.8. reset_statistics + 4.9. clear_statistics 5. RPC Commands @@ -105,6 +108,9 @@ Chapter 1. Admin Guide 4.4. uptime 4.5. version 4.6. which + 4.7. get_statistics + 4.8. reset_statistics + 4.9. clear_statistics 5. RPC Commands @@ -383,6 +389,9 @@ resetdebug(); 4.4. uptime 4.5. version 4.6. which + 4.7. get_statistics + 4.8. reset_statistics + 4.9. clear_statistics 4.1. arg @@ -456,6 +465,48 @@ resetdebug(); :which:_reply_fifo_file_ _empty_line_ +4.7. get_statistics + + Print the list of available internal statistics. + + Name: get_statistics + + Parameters: statsid - which statistics to be printed. If set to 'all' + then all statistics are printed; if set to 'statsgroup:' then all + statistics in the group are printed; if set to 'statsname' then the + statistics identified by the name is printed. + + MI FIFO Command Format: + :get_statistics:_reply_fifo_file_ + _statsid_ + _empty_line_ + +4.8. reset_statistics + + Reset internal statistics. + + Name: reset_statistics + + Parameters: statsid - which statistics to be reset, give as name. + + MI FIFO Command Format: + :reset_statistics:_reply_fifo_file_ + _statsid_ + _empty_line_ + +4.9. clear_statistics + + Return statistics and reset their value in one command. + + Name: get_statistics + + Parameters: statsid - same as for get_statistics. + + MI FIFO Command Format: + :clear_statistics:_reply_fifo_file_ + _statsid_ + _empty_line_ + 5. RPC Commands 5.1. pkg.stats diff --git a/modules_k/kex/doc/kex_admin.xml b/modules_k/kex/doc/kex_admin.xml index 02a27a6..8db736e 100644 --- a/modules_k/kex/doc/kex_admin.xml +++ b/modules_k/kex/doc/kex_admin.xml @@ -549,6 +549,73 @@ resetdebug(); _empty_line_ </programlisting> </section> + <section> + <title> + <function moreinfo="none">get_statistics</function> + </title> + <para> + Print the list of available internal statistics. + </para> + <para> + Name: <emphasis>get_statistics</emphasis> + </para> + <para>Parameters: <emphasis>statsid</emphasis> - which statistics to + be printed. If set to 'all' then all statistics are printed; if + set to 'statsgroup:' then all statistics in the group are printed; + if set to 'statsname' then the statistics identified by the name + is printed.</para> + <para> + MI FIFO Command Format: + </para> + <programlisting format="linespecific"> + :get_statistics:_reply_fifo_file_ + _statsid_ + _empty_line_ + </programlisting> + </section> + <section> + <title> + <function moreinfo="none">reset_statistics</function> + </title> + <para> + Reset internal statistics. + </para> + <para> + Name: <emphasis>reset_statistics</emphasis> + </para> + <para>Parameters: <emphasis>statsid</emphasis> - which statistics to + be reset, give as name.</para> + <para> + MI FIFO Command Format: + </para> + <programlisting format="linespecific"> + :reset_statistics:_reply_fifo_file_ + _statsid_ + _empty_line_ + </programlisting> + </section> + <section> + <title> + <function moreinfo="none">clear_statistics</function> + </title> + <para> + Return statistics and reset their value in one command. + </para> + <para> + Name: <emphasis>get_statistics</emphasis> + </para> + <para>Parameters: <emphasis>statsid</emphasis> - same as for + get_statistics.</para> + <para> + MI FIFO Command Format: + </para> + <programlisting format="linespecific"> + :clear_statistics:_reply_fifo_file_ + _statsid_ + _empty_line_ + </programlisting> + </section> + </section> <section>