$Revision: 1.7.2.1 $
$Date: 2005/06/22 23:12:00 $
User's Guide
Overview
acc module is used to report on transactions to syslog, SQL and
RADIUS.
To report on a transaction using syslog, use setflag
to mark a
transaction you are interested in with a flag, load accounting module and set its
log_flag
to the same flag number. The acc module will then report on
completed transaction to syslog. A typical usage of the module takes no acc-specific
script command -- the functionality binds invisibly through transaction processing.
Script writers just need to mark the transaction for accounting with proper setflag.
What is printed depends on module's log_fmt
parameter. It's a string with
characters specifying which parts of request should be printed:
c = Call-Id
d = To tag (Dst)
f = From
i = Inbound Request-URI
m = Method
o = Outbound Request-URI
r = fRom
s = Status
t = To
u = digest Username
p = username Part of inbound Request-URI
If a value is not present in request, "n/a" is accounted instead.
Note that:
A single INVITE may produce multiple accounting reports -- that's
due to SIP forking feature
Subsequent ACKs and other requests do not hit the server and can't be
accounted unless record-routing is enforced. The ACKs assert very little
useful information anyway and reporting on INVITE's 200 makes most
accounting scenarios happy.
There is no session accounting -- ser maintains no sessions. If one needs to
correlate INVITEs with BYEs for example for purpose of billing, then it is
better done in the entity which collects accounting information. Otherwise,
SIP server would have to become sessions-stateful, which would very badly
impact its scalability.
If a UA fails in middle of conversation, a proxy will never learn it.
In general, a better practice is to account from an end-device
(such as PSTN gateway), which best knows about call status
(including media status and PSTN status in case of the gateway).
Support for SQL and RADIUS works analogously. You need to enable it by recompiling the
module with properly set defines. Uncomment the SQL_ACC and RAD_ACC lines in
modules/acc/Makefile. To compile SQL support, you need to have mysqlclient package on
your system. To compile RADIUS support, you need to have radiusclient installed on your
system (version 0.4.1 or higher is required) which is available from
http://developer.berlios.de/projects/radiusclient-ng/. The radius client needs to
be configured properly. To do so, use the template at etc/radiusclient.conf and make sure
that module's radius_config parameter points to its location. In particular, accounting
secret must match that one configured in server and proper dictionary is used (one is
available at etc/sip_dictionary). Uses along with FreeRadius (http://www.freeradius.org/)
and Radiator (http://www.open.com.au/radiator/) servers have been reported to us.
Both mysql and radius libraries must be dynamically linkable. You need to configure your
OS so that SER, when started, will find them. Typically, you do so by manipulating
LD_LIBRARY_PATH environment variable or configuring ld.so.
General Example
loadmodule "modules/acc/acc.so"
modparam("acc", "log_level", 1)
modparam("acc", "log_flag", 1)
if (uri=~"sip:+49") /* calls to Germany */ {
if (!proxy_authorize("iptel.org" /* realm */,
"subscriber" /* table name */)) {
proxy_challenge("iptel.org" /* realm */, "0" /* no qop */ );
break;
}
if (method=="INVITE" & !check_from()) {
log("from!=digest\n");
sl_send_reply("403","Forbidden");
break;
}
setflag(1); /* set for accounting (the same value as in log_flag!)
t_relay(); /* enter stateful mode now */
};
Dependencies
The module depends on the following modules (in the other words the listed modules
must be loaded before this module):
tm -- Transaction Manager
a database module -- If compiled with database support.
Exported Parameters
<varname>secret</varname> (string)
Default value is randomly generated string.
Setting secret module parameter
modparam("auth", "secret", "johndoessecretphrase")
<varname>log_level</varname> (integer)
Log level at which accounting messages are issued to syslog.
Default value is L_NOTICE.
log_level example
modparam("acc", "log_level", 2) # Set log_level to 2
<varname>log_fmt</varname> (string)
Defines what parts of header fields will be printed to
syslog, see overview
for list of accepted values.
Default value is miocfs
.
log_fmt example
modparam("acc", "log_fmt", "mfs")
<varname>early_media</varname> (integer)
Should be early media (183) accounted too ?
Default value is 0 (no).
early_media example
modparam("acc", "early_media", 1)
<varname>failed_transactions</varname> (integer)
Should be failed transactions (status>=300) accounted too ?
Default value is 0 (no).
failed_transactions example
modparam("acc", "failed_transactions", 1)
<varname>log_flag</varname> (integer)
Request flag which needs to be set to account a transaction.
Default value is 1.
log_flag example
modparam("acc", "log_flag", 2)
<varname>log_missed_flag</varname> (integer)
Request flag which needs to be set to account missed calls.
Default value is 2.
log_missed_flag example
modparam("acc", "log_missed_flag", 3)
<varname>report_ack</varname> (integer)
Shall acc attempt to account e2e ACKs too ? Note that this is really only an
attempt, as e2e ACKs may take a different path (unless RR enabled) and mismatch
original INVITE (e2e ACKs are a separate transaction).
Default value is 1 (yes).
report_ack example
modparam("acc", "report_ack", 0)
<varname>report_cancels</varname> (integer)
By default, CANCEL reporting is disabled -- most accounting
applications are happy to see INVITE's cancellation status.
Turn on if you explicitly want to account CANCEL transactions.
Default value is 0 (no).
report_cancels example
modparam("acc", "report_cancels", 1)
<varname>radius_config</varname> (string)
This parameter is radius specific. Path to radius client
configuration file, set the referred config file correctly and specify there address
of server, shared secret (should equal that in /usr/local/etc/raddb/clients for
freeRadius servers) and dictionary, see etc for an example of config file and
dictionary.
Default value is /usr/local/etc/radiusclient/radiusclient.conf
.
radius_config example
modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
<varname>service_type</varname> (integer)
Radius service type used for accounting.
Default value is 15 (SIP).
service_type example
modparam("acc", "service_type", 16)
<varname>radius_flag</varname> (integer)
Request flag which needs to be set to account a transaction -- RADIUS specific.
Default value is 1.
radius_flag example
modparam("acc", "radius_flag", 2)
<varname>radius_missed_flag</varname> (integer)
Request flag which needs to be set to account missed calls -- RADIUS specific.
Default value is 2.
radius_missed_flag example
modparam("acc", "radius_missed_flag", 3)
<varname>db_url</varname> (string)
SQL address -- database specific.
Default value is mysql://ser:heslo@localhost/ser
db_url example
modparam("acc", "db_url", "mysql://user:password@localhost/ser")
<varname>db_flag</varname> (integer)
Request flag which needs to be set to account a transaction -- database specific.
Default value is 1.
db_flag example
modparam("acc", "db_flag", 2)
<varname>db_missed_flag</varname> (integer)
Request flag which needs to be set to account missed calls -- database specific.
Default value is 2.
db_missed_flag example
modparam("acc", "db_missed_flag", 3)
<varname>diameter_flag</varname> (integer)
Request flag which needs to be set to account a transaction -- DIAMETER specific.
Default value is 1.
diameter_flag example
modparam("acc", "diameter_flag", 2)
<varname>diameter_missed_flag</varname> (integer)
Request flag which needs to be set to account missed calls -- DIAMETER specific.
Default value is 2.
diameter_missed_flag example
modparam("acc", "diameter_missed_flag", 3)
<varname>diameter_client_host</varname> (string)
Hostname of the machine where the DIAMETER Client is running -- DIAMETER specific.
Default value is localhost
.
diameter_client_host example
modparam("acc", "diameter_client_host", "iptel.org")
<varname>diameter_client_port</varname> (int)
Port number where the Diameter Client is listening -- DIAMETER specific.
Default value is 3000.
diameter_client_host example
modparam("acc", "diameter_client_port", 3000)
<varname>db_table_acc</varname> (string)
Name of the table containing accounting information.
Default value is "acc".
<varname>db_table_missed_calls</varname> (string)
Name of the table containing accounting information about
missed calls.
Default value is "missed_calls".
<varname>db_localtime</varname> (int)
The parameter controls how date and time information for
accounted transactions will be stored in database. When set to
1 all time-related information will be based on the local time
zone. When set to 0 then acc module will use UTC.
Default value is 0 (use UTC).
<varname>acc_sip_from_column</varname> (string)
Name of the column containing the contents of From header field.
Default value is "sip_from".
<varname>acc_sip_to_column</varname> (string)
Name of the column containing the contents of To header field.
Default value is "sip_to".
<varname>acc_sip_status_column</varname> (string)
Name of the column containing status code of SIP replies.
Default value is "sip_status".
<varname>acc_sip_method_column</varname> (string)
Name of the column containing the SIP method of the request.
Default value is "sip_method".
<varname>acc_i_uri_column</varname> (string)
Name of the column containing the inbound Request-URI of the
acccounted SIP message. This is the URI that SER received.
Default value is "i_uri".
<varname>acc_o_uri_column</varname> (string)
Name of the column containing the outbound Request-URI of the
accounted SIP message. This is the final URI, after applying
all modifications from the configuration file. This is what the
downstream element will receive in the Request-URI of the
message forwarded by SER.
Default value is "o_uri".
<varname>acc_sip_callid_column</varname> (string)
Name of the column containing the contents of Call-ID header field.
Default value is "sip_callid".
<varname>acc_user_column</varname> (string)
Name of the column containing the username from digest credentials.
Default value is "username".
<varname>acc_time_column</varname> (string)
Date and time of arrival of the final reply that finished the
transaction.
Default value is "time".
<varname>acc_from_uri_column</varname> (string)
Name of the column containing the SIP URI extracted from the
From header field. This is usually the part enclosed in angle
brackets.
Default value is "from_uri".
<varname>acc_to_uri_column</varname> (string)
Name of the column containing the SIP URI extracted from the
To header field. This is usually the part enclosed in angle
brackets.
Default value is "to_uri".
<varname>acc_totag_column</varname> (string)
Name of the column containing the value of the To header field
tag parameter.
Default value is "totag".
<varname>acc_fromtag_column</varname> (string)
Name of the column containing the value of the From header
field tag parameter.
Default value is "fromtag".
<varname>acc_domain_column</varname> (string)
The name of the column containing the name of domain. This is
used when SER is operated in multi-domain mode.
Default value is "domain".
Exported Functions
<function moreinfo="none">acc_log_request(comment)</function>
acc_request reports on a request, for example,
it can be used to report on missed calls to off-line users who are replied 404. To
avoid multiple reports on UDP request retransmission, you would need to embed the
action in stateful processing.
Meaning of the parameters is as follows:
comment - Comment to be appended.
acc_log_request usage
...
acc_log_request("Some comment");
...
<function moreinfo="none">acc_db_request(comment, table)</function>
Like acc_log_request, acc_db_request reports on a request. The report is sent
to database at db_url
, in the table referred to in the second action
parameter
Meaning of the parameters is as follows:
comment - Comment to be appended.
table - Database table to be used.
acc_db_request usage
...
acc_log_request("Some comment", "Some table");
...
<function moreinfo="none">acc_rad_request(comment)</function>
Like acc_log_request,
acc_rad_request reports on a request. It
reports to radius server as configured in radius_config
.
Meaning of the parameters is as follows:
comment - Comment to be appended.
acc_rad_request usage
...
acc_rad_request("Some comment");
...
<function moreinfo="none">acc_diam_request(comment)</function>
Like acc_log_request,
acc_diam_request reports on a request. It
reports to Diameter server.
Meaning of the parameters is as follows:
comment - Comment to be appended.
acc_diam_request usage
...
acc_diam_request("Some comment");
...