1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
xlog Module
Elena-Ramona Modroiu
voice-system.ro
Edited by
Elena-Ramona Modroiu
Copyright 2003 FhG FOKUS
Copyright 2005 voice-system.ro
_________________________________________________________
Table of Contents
1. User's Guide
1.1. Overview
1.2. Implemented Specifiers
1.3. Dependencies
1.3.1. OpenSER Modules
1.3.2. External Libraries or Applications
1.4. Exported Parameters
1.4.1. buf_size (integer)
1.4.2. force_color (integer)
1.5. Exported Functions
1.5.1. xlog([level,] format)
1.5.2. xdbg(format)
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. Set buf_size parameter
1-2. Set force_color parameter
1-3. xlog usage
1-4. xdbg usage
_________________________________________________________
Chapter 1. User's Guide
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 or other variables from system. Section 1.2 shows
what can be printed out.
_________________________________________________________
1.2. Implemented Specifiers
The specifiers have been replaced by pseudo-variables which
are now part of OpenSER 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 OpenSER is
availabe at:
http://openser.org/docs/pseudo-variables-1.1.x.html
_________________________________________________________
1.3. Dependencies
1.3.1. OpenSER Modules
The following modules must be loaded before this module:
* No dependencies on other OpenSER modules.
_________________________________________________________
1.3.2. External Libraries or Applications
The following libraries or applications must be installed
before running OpenSER with this module loaded:
* None.
_________________________________________________________
1.4. Exported Parameters
1.4.1. buf_size (integer)
Maximum size of the log message.
Default value is 4096.
Example 1-1. Set buf_size parameter
...
modparam("xlog", "buf_size", 8192)
...
_________________________________________________________
1.4.2. force_color (integer)
When set to 1, forces color printing even if log_stderror=0.
Default value is 0.
Example 1-2. Set force_color parameter
...
modparam("xlog", "force_color", 0)
...
_________________________________________________________
1.5. Exported Functions
1.5.1. xlog([level,] format)
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.
Example 1-3. xlog usage
...
xlog("L_ERR", "time [$Tf] method <$rm> r-uri <$ru> 2nd via <$hdr(via[1]
)>\n");
...
_________________________________________________________
1.5.2. xdbg(format)
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.
Example 1-4. xdbg usage
...
xdbg("time $Cbx[$Tf]$Cxx method <$rm> r-uri <$ru>\n");
...
_________________________________________________________
Chapter 2. Developer's Guide
The module does not provide any API to use in other OpenSER
modules.
_________________________________________________________
Chapter 3. Frequently Asked Questions
3.1. Where can I find more about OpenSER?
3.2. Where can I post a question about this module?
3.3. How can I report a bug?
3.1. Where can I find more about OpenSER?
Take a look at http://openser.org/.
3.2. Where can I post a question about this module?
First at all check if your question was already answered on
one of our mailing lists:
* User Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/devel
E-mails regarding any stable OpenSER release should be sent to
<users@openser.org> and e-mails regarding development versions
should be sent to <devel@openser.org>.
If you want to keep the mail private, send it to
<team@openser.org>.
3.3. How can I report a bug?
Please follow the guidelines provided at:
http://sourceforge.net/tracker/?group_id=139143.
|
