formatted logging module
[sip-router] / modules_s / xlog / README
1 # $Id$
2  
3 XLOG - eXtended LOGging service for SER
4 =======================================
5
6
7 1.Description
8 -------------
9 This module provides the possibility to print user formatted log or debug
10 messages from SER scripts. It is possible to define 10 different formats.
11 Section '3.Implemented specifiers' shows what can be printed out.
12
13 2.Exported symbols
14 ------------------
15 Methods
16 -------
17
18 Parameters
19 ----------
20
21 Name:           buf_size
22 Type:           int
23 Default:        4096
24 Desc:           the max size of the log message
25
26
27 Name:           f0
28 Type:           string
29 Default:        "XLOG{0}: [%Tf] method:<%rm> r-uri:<%ru>\n"
30 Desc:           first log format
31
32
33 Name:           f1, ..., f9
34 Type:           string
35 Default:        NULL
36 Desc:           other log formats
37
38 Methods
39 -------
40
41 Name:   xlog
42 Params: - level: the level that will be used in LOG function
43         - format: the id of the format to be used to print the message (the
44                   digit after the 'f' of the module parameter name that represents the
45                   format to be used, e.g, 'xlog("1", "0")' will use the 'f0' format and
46                   will print the message with LOG(1, <log message>))
47 Desc:   print a formated message using LOG function
48
49 Name:   xdbg
50 Params: - format: the id of the format to be used to print the message (the
51           digit after the 'f' of the module parameter name that represents the
52           format to be used, e.g, 'xdbg("0")' will use the 'f0' format and
53           will print the message with DBG(<log message>))
54 Desc:   print a formatted message using DBG function
55
56                 
57 3.Implemented specifiers
58 ------------------------
59 - %%  : '%'
60
61 - %Ts : unix time stamp
62 - %Tf : string formatted time
63
64 - %ci : call-id
65 - %cs : cseq
66 - %ct : contact header
67 - %fu : 'From' uri
68 - %ft : 'From' tag
69 - %rm : request's method
70 - %ru : request's r-uri
71 - %tu : 'To' uri
72 - %tt : 'To' tag
73 - %mi : SIP message id
74 - %pp : process id (pid)