Acc Module

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:

n = Cseq number
c = Call-Id
m = Method
i = Inbound Request-URI
o = Outbound Request-URI
p = Username part of inbound Request-URI
D = Domain part of inbound Request-URI
f = From header
r = From TAG
F = From URI
0 = From URI user part
X = From URI domain part
t = To header
d = To TAG
T = To URI
1 = To URI user part
S = 3-digit Status code from reply
s = Status
U = User name (digest, From URI otherwise)
u = digest Username

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 -- OpenSER 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, RADIUS and DIAMETER works analogously. The SQL support is compiled in the moduls. For RADIUS and DIAMETER you need to enable it by recompiling the module with properly set defines: uncomment the RAD_ACC or DDIAM_ACC lines in modules/acc/Makefile. To compile RADIUS support, you need to have radiusclient-ng (only versions higher or equal to 0.5.0) installed on your system 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.

For Radius support, the radius libraries must be dynamically linkable. You need to configure your OS so that OpenSER, when started, will find it. Typically, you do so by manipulating LD_LIBRARY_PATH environment variable or configuring ld.so.

1.1.1. General Example

loadmodule "modules/acc/acc.so"
modparam("acc", "log_level", 1)
modparam("acc", "log_flag", 1)

if (uri=~"sip:+40") /* calls to Romania */ {
    if (!proxy_authorize("sip_domain.net" /* realm */,
    "subscriber" /* table name */))  {
        proxy_challenge("sip_domain.net" /* realm */, "0" /* no qop */ );
        exit;
    }

    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 */
};

1.2. Extra accounting

1.2.1. Overview

Along the static information defined via FMT-s, ACC modules allows dynamical selection of extra information to be logged. There are two classes of information that are accessible by extra accounting: data from SIP messages (as headers) and internal OpenSER data (as AVPs).

1.2.2. Definitions and syntax

Selection of extra information is done via xxx_extra parameters by specifying the names of additional information you want to log. This information is defined via pseudo-variables and may include headers or AVPs values or other message or system values. The syntax of the parameter is:

xxx_extra = extra_definition (';'extra_definition)*
extra_definition = log_name '=' pseudo_variable

The full list of supported pseudo-variables in OpenSER is availabe at: http://openser.org/docs/pseudo-variables-1.1.x.html

Via log_name you define how/where the data will be logged. Its meaning depends of the accounting support which is used:

LOG accounting - log_name will be just printed along with the data in log_name=data format;
DB accounting - log_name will be the name of the DB column where the data will be stored.IMPORTANT: add in db acc table the columns corresponding to each extra data;
RADIUS accounting - log_name will be the AVP name used for packing the data into RADIUS message. The log_name will be translated to AVP number via the dictionary. IMPORTANT: add in RADIUS dictionary the log_name attribute.
DIAMETER accounting - log_name will be the AVP code used for packing the data into DIAMETER message. The AVP code is given directly as integer, since DIAMETER has no dictionary support yet. IMPORTANT: log_name must be a number.

1.2.3. How it works

Some pseudo variables may return more than one value (like headers or AVPs). In this case, the returned values are embedded in a single string in a comma-separated format.

1.3. Multi Call-Legs accounting

1.3.1. Overview

A SIP call can have multiple legs due forwarding actions. For example user A calls user B which forwards the call to user C. There is only one SIP call but with 2 legs ( A to B and B to C). Accounting the legs of a call is required for proper billing of the calls (if C is a PSTN number and the call is billed, user B must pay for the call -as last party modifing the call destination-, and not A -as initiator of the call. Call forwarding on server is only one example which shows the necessity of the having an accounting engine with multiple legs support.

1.3.2. Configuration

First how it works? The idea is to store in several OpenSER AVP pairs the originator and destination for each call-leg. For the A call B and B forwards to C example, the AVP pairs are (A,B) and (B,C). There are two type of AVPs -source and destination- which refined a call-leg. The administator must take care and to properly insert these AVP from the script (in proper order and with correct type).

When the accouning infomation for the call will be written/sent, all the call-leg pairs will be added (based on found AVP pairs).

By default, the multiple call-legs support is disable - it can be enabled via the multi_leg_enabled module parameter. By enabling it, you will have also to define the AVPs to be used for source and destination (which define one call-leg). From performance reasons, the AVPs may be specified only via IDs.

1.3.3. Logged data

For each call, all the source-destination pairs (which defined a call-leg) will be looged. How the information will be actually logged, depends of the data backend:

syslog -- all pairs will be added to one record string as src_leg=xxx, dst_leg=xxxx pairs.
database -- each pair will be separatly logged (due DB data structure constraints); several records will be written, the difference between them being only the source & destination of the corresponding call-leg. with database support.
You will need to add in your DB (all acc related tables) the two colums for call-leg definition (source and destination).
Radius -- all pairs will be added to same Radius accounting message as RADIUS AVPs - for each call-leg two RADIUS AVPs will be added: source and destination
You will need to add in your dictionaty the two RADIUS AVPs used for call-leg definition (source and destination): Sip-Leg-Source and Sip-Leg-Destination
Diameter -- not supported. with database support.

1.4. Dependencies

1.4.1. OpenSER Modules

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 database support is used.
rr -- Record Route, if "detect_direction" module parameter is enabled.

1.4.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSER with this module loaded:

radiusclient-ng 0.5.0 or higher -- if compiled with RADIUS support. See http://developer.berlios.de/projects/radiusclient-ng/.

1.5. Exported Parameters

1.5.1. `early_media` (integer)

Should be early media (183) accounted too ?

Default value is 0 (no).

Example 1-1. early_media example

modparam("acc", "early_media", 1)

1.5.2. `failed_transaction_flag` (integer)

Per transaction flag which says if the transaction should be accounted also in case of failure (status>=300).

Default value is 0 (no flag).

Example 1-2. failed_transaction_flag example

modparam("acc", "failed_transaction_flag", 4)

1.5.3. `report_ack` (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).

Example 1-3. report_ack example

modparam("acc", "report_ack", 0)

1.5.4. `report_cancels` (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).

Example 1-4. report_cancels example

modparam("acc", "report_cancels", 1)

1.5.5. `multi_leg_enabled` (integer)

If set to a non 0 value, it will enables the logging of the call-legs. See Section 1.3 for a detailed description of the Multi Call-Legs accounting.

Default value is 0 (disabled).

Example 1-5. multi_leg_enabled example

modparam("acc", "multi_leg_enabled", 1)

1.5.6. `src_leg_avp_id` (integer)

Defines the AVP (ID AVP) which contains the source URI part of a call-leg. See Section 1.3 for a detailed description of the Multi Call-Legs accounting.

Default value is 0 (undefined).

Example 1-6. src_leg_avp_id example

modparam("acc", "src_leg_avp_id", 110)

1.5.7. `dst_leg_avp_id` (integer)

Defines the AVP (ID AVP) which contains the destination URI part of a call-leg. See Section 1.3 for a detailed description of the Multi Call-Legs accounting.

Default value is 0 (undefined).

Example 1-7. dst_leg_avp_id example

modparam("acc", "dst_leg_avp_id", 110)

1.5.8. `log_flag` (integer)

Request flag which needs to be set to account a transaction.

Default value is 1.

Example 1-8. log_flag example

modparam("acc", "log_flag", 2)

1.5.9. `log_missed_flag` (integer)

Request flag which needs to be set to account missed calls.

Default value is 2.

Example 1-9. log_missed_flag example

modparam("acc", "log_missed_flag", 3)

1.5.10. `log_level` (integer)

Log level at which accounting messages are issued to syslog.

Default value is L_NOTICE.

Example 1-10. log_level example

modparam("acc", "log_level", 2)   # Set log_level to 2

1.5.11. `log_fmt` (string)

Defines what parts of header fields will be printed to syslog, see "overview" for list of accepted values.

Default value is "miocfs".

Example 1-11. log_fmt example

modparam("acc", "log_fmt", "mfs")

1.5.12. `log_extra` (string)

Extra values to be logged.

Default value is NULL.

Example 1-12. log_extra example

modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")

1.5.13. `radius_config` (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 ".

Example 1-13. radius_config example

modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")

1.5.14. `radius_flag` (integer)

Request flag which needs to be set to account a transaction -- RADIUS specific.

Default value is 1.

Example 1-14. radius_flag example

modparam("acc", "radius_flag", 2)

1.5.15. `radius_missed_flag` (integer)

Request flag which needs to be set to account missed calls -- RADIUS specific.

Default value is 2.

Example 1-15. radius_missed_flag example

modparam("acc", "radius_missed_flag", 3)

1.5.16. `service_type` (integer)

Radius service type used for accounting.

Default value is 15 (SIP).

Example 1-16. service_type example

modparam("acc", "service_type", 16)

1.5.17. `radius_extra` (string)

Extra values to be logged via RADIUS - RADIUS specific.

Default value is NULL.

Example 1-17. radius_extra example

modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")

1.5.18. `diameter_flag` (integer)

Request flag which needs to be set to account a transaction -- DIAMETER specific.

Default value is 1.

Example 1-18. diameter_flag example

modparam("acc", "diameter_flag", 2)

1.5.19. `diameter_missed_flag` (integer)

Request flag which needs to be set to account missed calls -- DIAMETER specific.

Default value is 2.

Example 1-19. diameter_missed_flag example

modparam("acc", "diameter_missed_flag", 3)

1.5.20. `diameter_client_host` (string)

Hostname of the machine where the DIAMETER Client is running -- DIAMETER specific.

Default value is "localhost".

Example 1-20. diameter_client_host example

modparam("acc", "diameter_client_host", "3a_server.net")

1.5.21. `diameter_client_port` (int)

Port number where the Diameter Client is listening -- DIAMETER specific.

Default value is 3000.

Example 1-21. diameter_client_host example

modparam("acc", "diameter_client_port", 3000)

1.5.22. `diamter_extra` (string)

Extra values to be logged via DIAMETER - DIAMETER specific.

Default value is NULL.

Example 1-22. diameter_extra example

modparam("acc", "diameter_extra", "7846=$hdr(Content-type);7847=$avp(s:email)")

1.5.23. `db_flag` (integer)

Request flag which needs to be set to account a transaction -- database specific.

Default value is 1.

Example 1-23. db_flag example

modparam("acc", "db_flag", 2)

1.5.24. `db_missed_flag` (integer)

Request flag which needs to be set to account missed calls -- database specific.

Default value is 2.

Example 1-24. db_missed_flag example

modparam("acc", "db_missed_flag", 3)

1.5.25. `db_table_acc` (string)

Table name of accounting successfull calls -- database specific.

Default value is "acc"

Example 1-25. db_table_acc example

modparam("acc", "db_table_acc", "myacc_table")

1.5.26. `db_table_missed_calls` (string)

Table name for accounting missed calls -- database specific.

Default value is "missed_calls"

Example 1-26. db_table_missed_calls example

modparam("acc", "db_table_missed_calls", "myMC_table")

1.5.27. `db_url` (string)

SQL address -- database specific. If is set to NULL or emty string, the SQL support is disabled.

Default value is "NULL" (SQL disabled).

Example 1-27. db_url example

modparam("acc", "db_url", "mysql://user:password@localhost/openser")

1.5.28. `db_localtime` (int)

If DB timestamps should follow localtime or GMT time. Any non-zero value enables this option.

Default value is "0".

Example 1-28. db_localtime example

modparam("acc", "db_localtime", 1)  # use GMT time

1.5.29. `acc_sip_from_column` (string)

Column name in accouting table to store the "sip_from" value.

Default value is "sip_from".

Example 1-29. acc_sip_from_column example

modparam("acc", "acc_sip_from_column", "sip_from")

1.5.30. `acc_sip_to_column` (string)

Column name in accouting table to store the "sip_to" value.

Default value is "sip_to".

Example 1-30. acc_sip_to_column example

modparam("acc", "acc_sip_to_column", "sip_to")

1.5.31. `acc_sip_status_column` (string)

Column name in accouting table to store the "sip_status" value.

Default value is "sip_status".

Example 1-31. acc_sip_status_column example

modparam("acc", "acc_sip_status_column", "sip_status")

1.5.32. `acc_sip_method_column` (string)

Column name in accouting table to store the "sip_method" value.

Default value is "sip_method".

Example 1-32. acc_sip_method_column example

modparam("acc", "acc_sip_method_column", "sip_method")

1.5.33. `acc_i_uri_column` (string)

Column name in accouting table to store the "incoming_URI" value.

Default value is "i_uri".

Example 1-33. acc_i_uri_column example

modparam("acc", "acc_i_uri_column", "in_uri")

1.5.34. `acc_o_uri_column` (string)

Column name in accouting table to store the "outgoing_uri" value.

Default value is "o_uri".

Example 1-34. acc_o_uri_column example

modparam("acc", "acc_o_uri_column", "out_uri")

1.5.35. `acc_sip_callid_column` (string)

Column name in accouting table to store the "sip_callid" value.

Default value is "sip_callid".

Example 1-35. acc_sip_callid_column example

modparam("acc", "acc_sip_callid_column", "sip_callid")

1.5.36. `acc_user_column` (string)

Column name in accouting table to store the "username" value.

Default value is "username".

Example 1-36. acc_user_column example

modparam("acc", "acc_user_column", "username")

1.5.37. `acc_time_column` (string)

Column name in accouting table to store the "time" value.

Default value is "time".

Example 1-37. acc_time_column example

modparam("acc", "acc_time_column", "time")

1.5.38. `acc_from_uri_column` (string)

Column name in accouting table to store the "from_uri" value.

Default value is "from_uri".

Example 1-38. acc_from_uri_column example

modparam("acc", "acc_from_uri_column", "from_uri")

1.5.39. `acc_to_uri_column` (string)

Column name in accouting table to store the "to_uri" value.

Default value is "to_uri".

Example 1-39. acc_to_uri_column example

modparam("acc", "acc_to_uri_column", "to_uri")

1.5.40. `acc_totag_column` (string)

Column name in accouting table to store the "to_tag" value.

Default value is "totag".

Example 1-40. acc_totag_column example

modparam("acc", "acc_totag_column", "totag")

1.5.41. `acc_fromtag_column` (string)

Column name in accouting table to store the "from_tag" value.

Default value is "fromtag".

Example 1-41. acc_fromtag_column example

modparam("acc", "acc_fromtag_column", "fromtag")

1.5.42. `acc_domain_column` (string)

Column name in accouting table to store the "domain" value.

Default value is "domain".

Example 1-42. acc_domain_column example

modparam("acc", "acc_domain_column", "domain")

1.5.43. `acc_src_leg_column` (string)

Column name in accouting table to store the "source_leg" value in case of multi-leg accouting.

Default value is "src_leg".

Example 1-43. acc_src_leg_column example

modparam("acc", "acc_src_leg_column", "src_leg")

1.5.44. `acc_dst_leg_column` (string)

Column name in accouting table to store the "destination_leg" value in case of multi-leg accouting.

Default value is "dst_leg".

Example 1-44. acc_dst_leg_column example

modparam("acc", "acc_dst_leg_column", "dst_leg")

1.5.45. `db_extra` (string)

Extra values to be logged into database - DB specific.

Default value is NULL.

Example 1-45. db_extra example

modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)")

1.5.46. `detect_direction` (integer)

Controlles the direction detection for sequential requests. If enabled (non zero value), for sequential requests with upstream direction (from callee to caller), the FROM and TO will be swapped (the direction will be preserved as in the original request).

It affects all values related to TO and FROM headers (body, URI, username, domain, TAG).

Default value is 0 (disabled).

Example 1-46. detect_direction example

modparam("acc", "detect_direction", 1)

1.6. Exported Functions

1.6.1. `acc_log_request(comment)`

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 - Not Found. 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.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

Example 1-47. acc_log_request usage

...
acc_log_request("Some comment");
...

1.6.2. `acc_db_request(comment, table)`

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.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

Example 1-48. acc_db_request usage

...
acc_log_request("Some comment", "Some table");
...

1.6.3. `acc_rad_request(comment)`

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.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

Example 1-49. acc_rad_request usage

...
acc_rad_request("Some comment");
...

1.6.4. `acc_diam_request(comment)`

Like acc_log_request, acc_diam_request reports on a request. It reports to the configured Diameter server.

Meaning of the parameters is as follows:

comment - Comment to be appended.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

Example 1-50. acc_diam_request usage

...
acc_diam_request("Some comment");
...

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.