[sr-dev] git:master:57e05de6: debugger: updated documentation for the new facility parameters.

Module: kamailio Branch: master Commit: 57e05de6dbb2de117be32b785944dabdbff4e49e URL: https://github.com/kamailio/kamailio/commit/57e05de6dbb2de117be32b785944dab… Author: Stefan Mititelu &lt;stefan.mititelu(a)1and1.ro&gt; Committer: Stefan Mititelu &lt;stefan.mititelu(a)1and1.ro&gt; Date: 2015-06-10T15:41:43+03:00 debugger: updated documentation for the new facility parameters. Updated documentation for the new debugger facility params. --- Modified: modules/debugger/doc/debugger_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/57e05de6dbb2de117be32b785944dab… Patch: https://github.com/kamailio/kamailio/commit/57e05de6dbb2de117be32b785944dab… --- diff --git a/modules/debugger/doc/debugger_admin.xml b/modules/debugger/doc/debugger_admin.xml index 031e9e0..c4b6eb2 100644 --- a/modules/debugger/doc/debugger_admin.xml +++ b/modules/debugger/doc/debugger_admin.xml @@ -19,8 +19,9 @@ <para> This module provides an interactive config file debugger. It can print a trace of config script execution for a SIP message to log and set - breakpoints on every script action, allowing step-by-step execution of - the routing and response scripts. + breakpoints on every script action, allowing step-by-step execution of + the routing and response scripts. Moreover, this module allows setting + static and dynamic module specific debug settings. </para> <para> Debugging can be done from local or remote host via RPC interface (e.g., @@ -247,8 +248,11 @@ modparam("debugger", "step_loops", 100) <title><varname>mod_hash_size</varname> (int)</title> <para> Used to compute power of two as size of internal hash table to store levels - per module (e.g., if its set to 4, internal hash table has 16 slots). This - parameter is accesible readonly via the Kamailio config framework. + per module (e.g., if its set to 4, internal hash table has 16 slots). One + must set it's value grater than 0 such that memory to be allocated + to save the module specific debug levels or facility configured by + <varname>mod_level</varname> or <varname>mod_facility</varname>. + This parameter is accesible readonly via the Kamailio config framework. </para> <para> <emphasis> @@ -306,6 +310,52 @@ modparam("debugger", "mod_level", "tm=3") </example> </section> + <section id="dbg.p.mod_facility_mode"> + <title><varname>mod_facility_mode</varname> (int)</title> + <para> + Enable or disable per module log facility (0 - disabled, 1 - enabled). + This parameter is tunable via the Kamailio config framework. To use + per module log facility you also have to set <varname>mod_hash_size</varname>. + </para> + <para> + <emphasis> + Default value is <quote>0</quote>. + </emphasis> + </para> + <example> + <title>Set <varname>mod_facility_mode</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("debugger", "mod_facility_mode", 1) +... + </programlisting> + </example> + </section> + + <section id="dbg.p.mod_facility"> + <title><varname>mod_facility</varname> (str)</title> + <para> + Specify module log facility - the value must be in the format: + modulename=facility. The parameter can be set many times. For core + log facility, use module name 'core'. You also must enable + <varname>mod_facility_mode</varname> and <varname>mod_hash_size</varname>. + </para> + <para> + NOTE: See the <emphasis>syslog()</emphasis> library call for facility names (http://linux.die.net/man/3/syslog). + The most used facilities are LOG_LOCAL[0-7]. + </para> + + <example> + <title>Set <varname>mod_facility</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("debugger", "mod_facility", "core=LOG_LOCAL0") +modparam("debugger", "mod_facility", "debugger=LOG_LOCAL1") +... + </programlisting> + </example> + </section> + <section id="dbg.p.log_assign"> <title><varname>log_assign</varname> (int)</title> <para>