Merge commit 'origin/andrei/type_conversion'
[sip-router] / modules_s / acc_syslog / README
1 1. Acc Module
2
3 Jiri Kuthan
4
5    iptel.org
6    <jiri@iptel.org>
7
8    Copyright © 2002, 2003 FhG FOKUS
9    Revision History
10    Revision $Revision$ $Date$
11      __________________________________________________________________
12
13    1.1. Overview
14    1.2. Dependencies
15    1.3. Parameters
16
17         1.3.1. log_level (integer)
18         1.3.2. log_fmt (string)
19         1.3.3. early_media (integer)
20         1.3.4. failed_transactions (integer)
21         1.3.5. log_flag (integer)
22         1.3.6. log_missed_flag (integer)
23         1.3.7. report_ack (integer)
24         1.3.8. report_cancels (integer)
25         1.3.9. radius_config (string)
26         1.3.10. service_type (integer)
27         1.3.11. radius_flag (integer)
28         1.3.12. radius_missed_flag (integer)
29         1.3.13. db_url (string)
30         1.3.14. db_flag (integer)
31         1.3.15. db_missed_flag (integer)
32         1.3.16. diameter_flag (integer)
33         1.3.17. diameter_missed_flag (integer)
34         1.3.18. diameter_client_host (string)
35         1.3.19. diameter_client_port (int)
36
37    1.4. Functions
38
39         1.4.1. acc_log_request(comment)
40         1.4.2. acc_db_request(comment, table)
41         1.4.3. acc_rad_request(comment)
42         1.4.4. acc_diam_request(comment)
43
44 1.1. Overview
45
46    acc module is used to report on transactions to syslog, SQL and RADIUS.
47
48    To report on a transaction using syslog, use "setflag" to mark a
49    transaction you are interested in with a flag, load accounting module
50    and set its "log_flag" to the same flag number. The acc module will
51    then report on completed transaction to syslog. A typical usage of the
52    module takes no acc-specific script command -- the functionality binds
53    invisibly through transaction processing. Script writers just need to
54    mark the transaction for accounting with proper setflag.
55
56    What is printed depends on module's "log_fmt" parameter. It's a string
57    with characters specifying which parts of request should be printed:
58      * c = Call-Id
59      * d = To tag (Dst)
60      * f = From
61      * i = Inbound Request-URI
62      * m = Method
63      * o = Outbound Request-URI
64      * r = fRom
65      * s = Status
66      * t = To
67      * u = digest Username
68      * p = username Part of inbound Request-URI
69
70    If a value is not present in request, "n/a" is accounted instead.
71
72 Note
73
74      * A single INVITE may produce multiple accounting reports -- that's
75        due to SIP forking feature
76      * Subsequent ACKs and other requests do not hit the server and can't
77        be accounted unless record-routing is enforced. The ACKs assert
78        very little useful information anyway and reporting on INVITE's 200
79        makes most accounting scenarios happy.
80      * There is no session accounting -- ser maintains no sessions. If one
81        needs to correlate INVITEs with BYEs for example for purpose of
82        billing, then it is better done in the entity which collects
83        accounting information. Otherwise, SIP server would have to become
84        sessions-stateful, which would very badly impact its scalability.
85      * If a UA fails in middle of conversation, a proxy will never learn
86        it. In general, a better practice is to account from an end-device
87        (such as PSTN gateway), which best knows about call status
88        (including media status and PSTN status in case of the gateway).
89
90    Support for SQL and RADIUS works analogously. You need to enable it by
91    recompiling the module with properly set defines. Uncomment the SQL_ACC
92    and RAD_ACC lines in modules/acc/Makefile. To compile SQL support, you
93    need to have mysqlclient package on your system. To compile RADIUS
94    support, you need to have radiusclient installed on your system
95    (version 0.5.0 or higher is required) which is available from
96    http://developer.berlios.de/projects/radiusclient-ng/. The radius
97    client needs to be configured properly. To do so, use the template in
98    sip_router/etc/radiusclient.conf and make sure that module's
99    radius_config parameter points to its location. Uses along with
100    FreeRADIUS and Radiator servers have been reported to us.
101
102    Both mysql and radius libraries must be dynamically linkable. You need
103    to configure your OS so that SER, when started, will find them.
104    Typically, you do so by manipulating LD_LIBRARY_PATH environment
105    variable or configuring ld.so.
106
107    Example 1. General Example
108 loadmodule "modules/acc/acc.so"
109 modparam("acc", "log_level", 1)
110 modparam("acc", "log_flag", 1)
111
112 if (uri=~"sip:+49") /* calls to Germany */ {
113     if (!proxy_authorize("iptel.org" /* realm */,
114                          "subscriber" /* table name */))  {
115         proxy_challenge("iptel.org" /* realm */, "0" /* no qop */ );
116         break;
117     }
118
119     if (method=="INVITE" & !check_from()) {
120         log("from!=digest\n");
121         sl_send_reply("403","Forbidden");
122         break;
123     }
124
125     setflag(1); /* set for accounting (the same value as in log_flag!)
126     t_relay();  /* enter stateful mode now */
127 };
128
129 1.2. Dependencies
130
131    The module depends on the following modules (in the other words the
132    listed modules must be loaded before this module):
133      * tm. Transaction Manager
134      * A database module (mysql,postgres,dbtext). If compiled with
135        database support.
136
137 1.3. Parameters
138
139    Revision History
140    Revision $Revision$ $Date$
141
142 1.3.1. log_level (integer)
143
144    Log level at which accounting messages are issued to syslog.
145
146    Default value is L_NOTICE.
147
148    Example 2. log_level example
149 modparam("acc", "log_level", 2)   # Set log_level to 2
150
151 1.3.2. log_fmt (string)
152
153    Defines what parts of header fields will be printed to syslog, see
154    "overview" for list of accepted values.
155
156    Default value is "miocfs".
157
158    Example 3. log_fmt example
159 modparam("acc", "log_fmt", "mfs")
160
161 1.3.3. early_media (integer)
162
163    Should be early media (183) accounted too ?
164
165    Default value is 0 (no).
166
167    Example 4. early_media example
168 modparam("acc", "early_media", 1)
169
170 1.3.4. failed_transactions (integer)
171
172    This parameter controls whether failed transactions (with final reply
173    >= 300) should be accounted too.
174
175    Default value is 0 (no).
176
177    Example 5. failed_transactions example
178 modparam("acc", "failed_transactions", 1)
179
180 1.3.5. log_flag (integer)
181
182    Request flag which needs to be set to account a transaction.
183
184    Default value is 1.
185
186    Example 6. log_flag example
187 modparam("acc", "log_flag", 2)
188
189 1.3.6. log_missed_flag (integer)
190
191    Request flag which needs to be set to account missed calls.
192
193    Default value is 2.
194
195    Example 7. log_missed_flag example
196 modparam("acc", "log_missed_flag", 3)
197
198 1.3.7. report_ack (integer)
199
200    Shall acc attempt to account e2e ACKs too ? Note that this is really
201    only an attempt, as e2e ACKs may take a different path (unless RR
202    enabled) and mismatch original INVITE (e2e ACKs are a separate
203    transaction).
204
205    Default value is 1 (yes).
206
207    Example 8. report_ack example
208 modparam("acc", "report_ack", 0)
209
210 1.3.8. report_cancels (integer)
211
212    By default, CANCEL reporting is disabled -- most accounting
213    applications are happy to see INVITE's cancellation status. Turn on if
214    you explicitly want to account CANCEL transactions.
215
216    Default value is 0 (no).
217
218    Example 9. report_cancels example
219 modparam("acc", "report_cancels", 1)
220
221 1.3.9. radius_config (string)
222
223    This parameter is radius specific. Path to radius client configuration
224    file, set the referred config file correctly and specify there address
225    of server, shared secret (should equal that in
226    /usr/local/etc/raddb/clients for freeRadius servers) and dictionary,
227    see etc for an example of config file and dictionary.
228
229    Default value is "/usr/local/etc/radiusclient/radiusclient.conf".
230
231    Example 10. radius_config example
232 modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
233
234 1.3.10. service_type (integer)
235
236    Radius service type used for accounting.
237
238    Default value is 15 (SIP).
239
240    Example 11. service_type example
241 modparam("acc", "service_type", 16)
242
243 1.3.11. radius_flag (integer)
244
245    Request flag which needs to be set to account a transaction -- RADIUS
246    specific.
247
248    Default value is 1.
249
250    Example 12. radius_flag example
251                 modparam("acc", "radius_flag", 2)
252
253 1.3.12. radius_missed_flag (integer)
254
255    Request flag which needs to be set to account missed calls -- RADIUS
256    specific.
257
258    Default value is 2.
259
260    Example 13. radius_missed_flag example
261 modparam("acc", "radius_missed_flag", 3)
262
263 1.3.13. db_url (string)
264
265    SQL address -- database specific.
266
267    Default value is "mysql://ser:heslo@localhost/ser"
268
269    Example 14. db_url example
270 modparam("acc", "db_url", "mysql://user:password@localhost/ser")
271
272 1.3.14. db_flag (integer)
273
274    Request flag which needs to be set to account a transaction -- database
275    specific.
276
277    Default value is 1.
278
279    Example 15. db_flag example
280 modparam("acc", "db_flag", 2)
281
282 1.3.15. db_missed_flag (integer)
283
284    Request flag which needs to be set to account missed calls -- database
285    specific.
286
287    Default value is 2.
288
289    Example 16. db_missed_flag example
290 modparam("acc", "db_missed_flag", 3)
291
292 1.3.16. diameter_flag (integer)
293
294    Request flag which needs to be set to account a transaction -- DIAMETER
295    specific.
296
297    Default value is 1.
298
299    Example 17. diameter_flag example
300 modparam("acc", "diameter_flag", 2)
301
302 1.3.17. diameter_missed_flag (integer)
303
304    Request flag which needs to be set to account missed calls -- DIAMETER
305    specific.
306
307    Default value is 2.
308
309    Example 18. diameter_missed_flag example
310 modparam("acc", "diameter_missed_flag", 3)
311
312 1.3.18. diameter_client_host (string)
313
314    Hostname of the machine where the DIAMETER Client is running --
315    DIAMETER specific.
316
317    Default value is "localhost".
318
319    Example 19. diameter_client_host example
320 modparam("acc", "diameter_client_host", "iptel.org")
321
322 1.3.19. diameter_client_port (int)
323
324    Port number where the Diameter Client is listening -- DIAMETER
325    specific.
326
327    Default value is 3000.
328
329    Example 20. diameter_client_host example
330 modparam("acc", "diameter_client_port", 3000)
331
332 1.4. Functions
333
334    Revision History
335    Revision $Revision$ $Date$
336
337 1.4.1. acc_log_request(comment)
338
339    acc_request reports on a request, for example, it can be used to report
340    on missed calls to off-line users who are replied 404. To avoid
341    multiple reports on UDP request retransmission, you would need to embed
342    the action in stateful processing.
343
344    Meaning of the parameters is as follows:
345      * comment - Comment to be appended.
346
347    Example 21. acc_log_request usage
348 ...
349 acc_log_request("Some comment");
350 ...
351
352 1.4.2. acc_db_request(comment, table)
353
354    Like acc_log_request, acc_db_request reports on a request. The report
355    is sent to database at "db_url", in the table referred to in the second
356    action parameter
357
358    Meaning of the parameters is as follows:
359      * comment - Comment to be appended.
360      * table - Database table to be used.
361
362    Example 22. acc_db_request usage
363 ...
364 acc_log_request("Some comment", "Some table");
365 ...
366
367 1.4.3. acc_rad_request(comment)
368
369    Like acc_log_request, acc_rad_request reports on a request. It reports
370    to radius server as configured in "radius_config".
371
372    Meaning of the parameters is as follows:
373      * comment - Comment to be appended.
374
375    Example 23. acc_rad_request usage
376 ...
377 acc_rad_request("Some comment");
378 ...
379
380 1.4.4. acc_diam_request(comment)
381
382    Like acc_log_request, acc_diam_request reports on a request. It reports
383    to Diameter server.
384
385    Meaning of the parameters is as follows:
386      * comment - Comment to be appended.
387
388    Example 24. acc_diam_request usage
389 ...
390 acc_diam_request("Some comment");
391 ...