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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
SipTrace Module
Daniel-Constantin Mierla
voice-system.ro
Edited by
Daniel-Constantin Mierla
Copyright 2006 voice-system.ro
_________________________________________________________
Table of Contents
1. User's Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSER Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. db_url (str)
1.3.2. table (str)
1.3.3. trace_flag (integer)
1.3.4. trace_on (integer)
1.3.5. duplicate_uri (str)
1.4. Exported Functions
1.4.1. siptrace()
1.5. sip_trace table definition
1.6. Known issues
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. Set db_url parameter
1-2. Set sip_trace parameter
1-3. Set trace_flag parameter
1-4. Set trace_on parameter
1-5. Set duplicate_uri parameter
1-6. siptrace() usage
1-7. sip_trace sql
_________________________________________________________
Chapter 1. User's Guide
1.1. Overview
Offer a possibility to store incoming/outgoing SIP messages in
database.
There are two ways of storing information.
* by calling explicitely the sip_trace() method in OpenSER
configuration file. In this case the original message is
processed.
* by setting the flag equal with the value of 'trace_flag'
(e.g., setflag(__trace_flag__)) parameter of the module.
In this case, the\ message sent forward is processed. The
logging mechanism is based on TM/SL callbacks, so only
messages processed with TM/SL are logged.
The tracing can be turned on/off using fifo commad.
openserctl fifo sip_trace on
openserctl fifo sip_trace off
_________________________________________________________
1.2. Dependencies
1.2.1. OpenSER Modules
The following modules must be loaded before this module:
* database module - mysql, postrgress, dbtext, unixodbc...
* tm and sl modules - optional, only if you want to trace
messages forwarded by these modules.
_________________________________________________________
1.2.2. External Libraries or Applications
The following libraries or applications must be installed
before running OpenSER with this module loaded:
* None.
_________________________________________________________
1.3. Exported Parameters
1.3.1. db_url (str)
Database URL.
Default value is "".
Example 1-1. Set db_url parameter
...
modparam("siptrace", "db_url", "mysql://user:passwd@host/dbname")
...
_________________________________________________________
1.3.2. table (str)
Name of the table where to store the SIP messages.
Default value is "sip_trace".
Example 1-2. Set sip_trace parameter
...
modparam("siptrace", "table", "strace")
...
_________________________________________________________
1.3.3. trace_flag (integer)
Which flag is used to mark messages to trace
Default value is "0".
Example 1-3. Set trace_flag parameter
...
modparam("siptrace", "trace_flag", 22)
...
_________________________________________________________
1.3.4. trace_on (integer)
Parameter to enable/disable trace (on(1)/off(0))
Default value is "0".
Example 1-4. Set trace_on parameter
...
modparam("siptrace", "trace_on", 1)
...
_________________________________________________________
1.3.5. duplicate_uri (str)
The address in form of SIP uri where to send a duplicate of
traced message. It uses UDP all the time.
Default value is "NULL".
Example 1-5. Set duplicate_uri parameter
...
modparam("siptrace", "duplicate_uri", "sip:10.1.1.1:5888")
...
_________________________________________________________
1.4. Exported Functions
1.4.1. siptrace()
Store current processed SIP message in database. It is stored
in the form prior applying chages made to it.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE.
Example 1-6. siptrace() usage
...
siptrace();
...
_________________________________________________________
1.5. sip_trace table definition
Next is presented the definition of sip_trace table
Example 1-7. sip_trace sql
CREATE TABLE `sip_trace` (
`id` bigint(20) NOT NULL auto_increment,
`date` datetime NOT NULL default '0000-00-00 00:00:00',
`callid` varchar(254) NOT NULL default '',
`traced_user` varchar(128) NOT NULL default '',
`msg` text NOT NULL,
`method` varchar(50) NOT NULL default '',
`status` varchar(254) NOT NULL default '',
`fromip` varchar(50) NOT NULL default '',
`toip` varchar(50) NOT NULL default '',
`fromtag` varchar(64) NOT NULL default '',
`direction` varchar(4) NOT NULL default '',
PRIMARY KEY (`id`),
INDEX user_idx (traced_user),
INDEX date_id (date),
INDEX ip_idx (fromip),
KEY `call_id` (`callid`)
);
_________________________________________________________
1.6. Known issues
Stateless forwarded messages (forward()) are not logged if you
set the flag, use sip_trace().
_________________________________________________________
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.
|
