$Revision: 403 $
$Date: 2005-11-28 15:39:19 +0200 (Mon, 28 Nov 2005) $
User's Guide
Overview
This module provides the possibility to print user formatted log or
debug messages from &ser; scripts, similar to printf function but now
a specifier is replaced with a part of the &sip; request or other
variables from system.
shows what can be printed
out.
Implemented Specifiers
The specifiers have been replaced by pseudo-variables which are
now part of &ser; core and are used by other modules as well (e.g., avpops
in the function avp_printf())
The most important changes are:
- '%' has been replaced by '$'
- to print a header, use now $hdr(header_name[index]) instead of
%{header_name[index]}
- to print an AVP, use now $avp([si]:avp_id[index]) instead of
%{[si]:avp_id[index]} or $avp([$avp_alias[index]) instead of
%{[$avp_alias[index]}
The full list of available pseudo-variables in &ser; is availabe at:
http://openser.org/docs/pseudo-variables-1.1.x.html
Dependencies
&ser; Modules
The following modules must be loaded before this module:
No dependencies on other &ser; modules.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>buf_size</varname> (integer)
Maximum size of the log message.
Default value is 4096.
Set <varname>buf_size</varname> parameter
...
modparam("xlog", "buf_size", 8192)
...
<varname>force_color</varname> (integer)
When set to 1, forces color printing even if log_stderror=0.
Default value is 0.
Set <varname>force_color</varname> parameter
...
modparam("xlog", "force_color", 0)
...
Exported Functions
<function moreinfo="none">xlog([level,] format)</function>
Print a formated message using LOG function.
Meaning of the parameters is as follows:
level - The level that will be used in LOG function. It can be:
L_ALERT
L_CRIT
L_ERR
L_WARN
L_NOTICE
L_INFO
L_DBG
What really matters is the third letter of the value.
If this parameter is missing, the implicit log level is 'L_ERR'.
format - The formatted string to be printed.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
<function>xlog</function> usage
...
xlog("L_ERR", "time [$Tf] method <$rm> r-uri <$ru> 2nd via <$hdr(via[1])>\n");
...
<function moreinfo="none">xdbg(format)</function>
Print a formatted message using DBG function.
Meaning of the parameters is as follows:
format - The formatted string to be printed.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
<function>xdbg</function> usage
...
xdbg("time $Cbx[$Tf]$Cxx method <$rm> r-uri <$ru>\n");
...