1212 with hep. All hep parameters moved inside proto_hep.
1313 </para >
1414 <para >
15- The 2.2 version of &osips; came with a major improvement in siptrace module.
16- Now all you have to do is call <emphasis >sip_trace ()</emphasis > function
15+ The 2.2 version of &osips; came with a major improvement in tracer module.
16+ Now all you have to do is call <emphasis >trace ()</emphasis > function
1717 with the proper parameters and it will do the job for you. Now you can trace
1818 messages, transactions and dialogs with the same function. Also, you can trace
1919 to multiple databases, multiple hep destinations and sip destinations using
2020 only one parameter. All you need now is defining <emphasis >trace_id</emphasis >
2121 parameters in modparam section and switch between them in
22- siptrace function. Also you cand turn tracing on
22+ tracer function. Also you cand turn tracing on
2323 and off using <emphasis >trace_on</emphasis > either globally(for all trace_ids)
2424 or for a certain trace_id.
2525 </para >
3232 The tracing tracing can be turned on/off using fifo command.
3333 </para >
3434 <para >
35- opensips-cli -x mi sip_trace on
36- opensips-cli -x mi sip_trace [some_trace_id] on
35+ opensips-cli -x mi trace on
36+ opensips-cli -x mi trace [some_trace_id] on
3737 </para >
3838 <para >
39- opensips-cli -x mi sip_trace off
40- opensips-cli -x mi sip_trace [some_trace_id] off
39+ opensips-cli -x mi trace off
40+ opensips-cli -x mi trace [some_trace_id] off
4141 </para >
4242 </section >
4343 <section id =" dependencies" xreflabel =" Dependencies"
103103 <title >Set <varname >trace_on</varname > parameter</title >
104104 <programlisting format =" linespecific"
105105...
106- modparam("siptrace ", "trace_on", 1)
106+ modparam("tracer ", "trace_on", 1)
107107...
108108</programlisting >
109109 </example >
@@ -128,22 +128,22 @@ modparam("siptrace", "trace_on", 1)
128128 <programlisting format =" linespecific"
129129...
130130#Resulting address: udp:10.1.1.1:5064
131- modparam("siptrace ", "trace_local_ip", "10.1.1.1:5064")
131+ modparam("tracer ", "trace_local_ip", "10.1.1.1:5064")
132132...
133133
134134...
135135#Resulting address: tcp:10.1.1.1:5060
136- modparam("siptrace , "trace_local_ip", "tcp:10.1.1.1")
136+ modparam("tracer , "trace_local_ip", "tcp:10.1.1.1")
137137...
138138
139139...
140140#Resulting address: tcp:10.1.1.1:5064
141- modparam("siptrace ", "trace_local_ip", "tcp:10.1.1.1:5064")
141+ modparam("tracer ", "trace_local_ip", "tcp:10.1.1.1:5064")
142142...
143143
144144...
145145#Resulting address: udp:10.1.1.1:5060
146- modparam("siptrace ", "trace_local_ip", "10.1.1.1")
146+ modparam("tracer ", "trace_local_ip", "10.1.1.1")
147147...
148148</programlisting >
149149 </example >
@@ -168,7 +168,7 @@ modparam("siptrace", "trace_local_ip", "10.1.1.1")
168168 One can declare multiple types of tracing under the same trace
169169 id, being identified by their name. So if you define two
170170 database url, one hep uri and one sip uri with the same name,
171- when calling sip_trace () with this name tracing shall be done
171+ when calling trace () with this name tracing shall be done
172172 to all the destinations.
173173 </para >
174174 <para >
@@ -185,19 +185,19 @@ modparam("siptrace", "trace_local_ip", "10.1.1.1")
185185 <programlisting format =" linespecific"
186186...
187187/*DB trace id*/
188- modparam("siptrace ", "trace_id",
188+ modparam("tracer ", "trace_id",
189189"[tid]
190190uri=mysql://xxxx:
[email protected] /opensips;
191191table=new_sip_trace;")
192192/* hep trace id with the hep id defined in proto_hep; check proto_hep docs
193193 * for more information */
194194modparam("proto_hep", "hep_id", "[hid]10.10.10.10")
195- modparam("siptrace ", "trace_id", "[tid]uri=hep:hid")
195+ modparam("tracer ", "trace_id", "[tid]uri=hep:hid")
196196/*sip trace id*/
197- modparam("siptrace ", "trace_id",
197+ modparam("tracer ", "trace_id",
198198"[tid]uri=sip:10.10.10.11:5060")
199199/* notice that they all have the same name
200- * meaning that calling sip_trace ("tid",...)
200+ * meaning that calling trace ("tid",...)
201201 * will do sql, sip and hep tracing */
202202...
203203</programlisting >
@@ -208,14 +208,15 @@ modparam("siptrace", "trace_id",
208208
209209 <section id =" exported_functions" xreflabel =" exported_functions"
210210 <title >Exported Functions</title >
211- <section id =" func_sip_trace " xreflabel =" sip_trace ()"
211+ <section id =" func_trace " xreflabel =" trace ()"
212212 <title >
213- <function moreinfo =" none" sip_trace (trace_id, [scope, [type, [trace_attrs]]])</function >
213+ <function moreinfo =" none" trace (trace_id, [scope, [type, [trace_attrs]]])</function >
214214 </title >
215+ <para >This function has replaced the <emph >sip_trace()</emph > in &osips; 3.0.</para >
215216 <para >
216217 Store or replocate current processed SIP message,transaction or dialogin database.
217218 It is stored in the form prior applying chages made to it. The traced_user_avp
218- parameter is now an argument to sip_trace () function. Since version 2.2, sip_trace()
219+ parameter is now an argument to trace () function. Since version 2.2, this function
219220 also catches internally generated replies in stateless mode(sl_send_reply(...)).
220221 </para >
221222 <para >
@@ -282,7 +283,7 @@ modparam("siptrace", "trace_id",
282283
283284 </itemizedlist >
284285 <example >
285- <title ><function >sip_trace ()</function > usage</title >
286+ <title ><function >trace ()</function > usage</title >
286287 <programlisting format =" linespecific"
287288...
288289/* see declaration of tid in trace_id section */
@@ -295,35 +296,35 @@ modparam("siptrace", "trace_id",
295296 match_dialog();
296297 } else {
297298 if (is_method("INVITE") {
298- sip_trace ("$var(trace_id)", "d", "sip|xlog", "$var(user)");
299+ trace ("$var(trace_id)", "d", "sip|xlog", "$var(user)");
299300 }
300301 }
301302...
302303/* Example 2: how to trace initial INVITE and BYE, sip and rest */
303304 if (has_totag()) {
304305 if (is_method("BYE")) {
305- sip_trace ("$var(trace_id)", "m", "sip|rest", "$var(user)");
306+ trace ("$var(trace_id)", "m", "sip|rest", "$var(user)");
306307 }
307308 } else {
308309 if (is_method("INVITE")) {
309- sip_trace ("$var(trace_id)", "m", "sip|rest", "$var(user)");
310+ trace ("$var(trace_id)", "m", "sip|rest", "$var(user)");
310311 }
311312 }
312313
313314...
314315/* Example 3: trace initial INVITE transaction's only xlog and rest, no sip */
315316 if (!has_totag()) {
316317 if (is_method("INVITE")) {
317- sip_trace ("$var(trace_id)", "t", "xlog|rest", "$var(user)");
318+ trace ("$var(trace_id)", "t", "xlog|rest", "$var(user)");
318319 }
319320 }
320321...
321322/* Example 4: stateless transaction aware mode!*/
322323/* tm module must not be loaded */
323324 if (is_method("REGISTER")) {
324- sip_trace ("$var(trace_id)", "t", "xlog|rest", "$var(user)");
325+ trace ("$var(trace_id)", "t", "xlog|rest", "$var(user)");
325326 if (!www_authorize("", "subscriber")) {
326- /* siptrace will also catch the 401 generated by www_challenge() */
327+ /* tracer will also catch the 401 generated by www_challenge() */
327328 www_challenge("", "1");
328329 }
329330 }
@@ -334,32 +335,32 @@ modparam("siptrace", "trace_id",
334335
335336 <section id =" exported_mi_functions" xreflabel =" Exported MI Functions"
336337 <title >Exported MI Functions</title >
337- <section id =" mi_sip_trace " xreflabel =" sip_trace "
338+ <section id =" mi_trace " xreflabel =" trace "
338339 <title >
339- <function moreinfo =" none" sip_trace </function >
340+ <function moreinfo =" none" trace </function >
340341 </title >
341342 <para >
342343 Enable/disable tracing(globally or for a specific trace id) or dump
343344 info about trace ids.
344345 </para >
345346 <para >
346- Name: <emphasis >sip_trace </emphasis >
347+ Name: <emphasis >trace </emphasis >
347348 </para >
348349 <para >
349350 Parameters:
350351 </para >
351352 <itemizedlist >
352353 <listitem >
353354 <para >
354- <emphasis >trace_id </emphasis > (optional) -
355- a trace_id name. If this parameter is missing the command will
355+ <emphasis >id </emphasis > (optional) - the name of the tracing instance.
356+ If this parameter is missing the command will
356357 either dump info for all tace ids(and return the global tracing state)
357358 or set the global tracing state.
358359 </para >
359360 </listitem >
360361 <listitem >
361362 <para >
362- <emphasis >trace_mode </emphasis > (optional) -
363+ <emphasis >mode </emphasis > (optional) -
363364 possible values are:
364365 </para >
365366 <itemizedlist >
@@ -377,7 +378,7 @@ modparam("siptrace", "trace_id",
377378 If this parameter is missing but the first is set, the command will
378379 only dump info about that specific trace id. If both parameters are
379380 missing, the command will return the global tracing state and dump
380- info for each trace_id .
381+ info for each id .
381382 </para >
382383 </listitem >
383384 </itemizedlist >
@@ -386,7 +387,7 @@ modparam("siptrace", "trace_id",
386387 MI FIFO Command Format:
387388 </para >
388389 <programlisting format =" linespecific"
389- opensips-cli -x mi sip_trace tid2 on
390+ opensips-cli -x mi trace tid2 on
390391 </programlisting >
391392 </section >
392393
@@ -395,10 +396,10 @@ modparam("siptrace", "trace_id",
395396 <section >
396397 <title >Database setup</title >
397398 <para >
398- Before running &osips; with siptrace , you have to setup the database
399+ Before running &osips; with tracer , you have to setup the database
399400 tables where the module will store the data. For that, if the
400401 table were not created by the installation script or you choose
401- to install everything by yourself you can use the siptrace -create.sql
402+ to install everything by yourself you can use the tracer -create.sql
402403 <acronym >SQL</acronym > script in the database directories in the
403404 opensips/scripts folder as template.
404405 You can also find the complete database documentation on the
0 commit comments