1.1. Overview

This module provides the possibility to print user formatted log or debug messages from OpenSER scripts, similar to printf function but now a specifier is replaced with a part of the SIP request. Section 1.2 shows what can be printed out.

1.2. Implemented Specifiers

• %% : '%'

• %br : request's first branch

• %bR : request's all branches

• %ci : call-id

• %cs : cseq

• %ct : contact header

• %ds : destination set

• %du : destination uri

• %fu : 'From' uri

• %ft : 'From' tag

• %mb : whole SIP message buffer

• %mf : flags set for current SIP request

• %mF : flags set for current SIP request in hexa

• %mi : SIP message id

• %ml : SIP message length

• %pp : process id (pid)

• %rm : request's method

• %rr : reply's reason

• %rs : reply's status

• %ru : request's r-uri

• %Ri : IP address of the interface where the request has been received

• %Rp : received port

• %si : IP source address (previously was %is)

• %sp : source port

• %tt : 'To' tag

• %tu : 'To' uri

• %Tf : string formatted time

• %Ts : unix time stamp

• %ua : User agent header field

• %{id[N]} : print headers or AVPs

  • %{name[N]} : print the body of the Nth header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.

    The module should identify most of compact header names (the ones recognized by OpenSER which should be all at this moment), if not, the compact form has to be specified explicitely. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster.

  • %{[si]:name[N]} : print the value of the AVP identified by 'name'. The leter before ':' specifies the type of the AVP name (i - integer, s - string; when missing it is considered string). N has the meaning as for header printing.

  • %{$name[N]} : print the value of the AVP identified by the alias 'name'. N has the meaning as for header printing.

1.3. Dependencies

1.4. Exported Parameters

...
modparam("xlog", "buf_size", 8192)
...

1.5. Exported Functions

...
xlog("L_ERR", "time [%Tf] method <%rm> r-uri <%ru> 2nd via <%{via[1]}>\n");
...

...
xdbg("time [%Tf] method <%rm> r-uri <%ru>\n");
...