iptel.org - accounting

SER Wishlist

Sun, 23 Apr 2006 15:47:31 +0200

This is the page where YOU add your most wanted SERi features or modules! Please feel free to edit this page.

See a more detailed list of wishlist items on the tracker (items on this wishlist will end up in the tracker when they are detailed enough to do actual coding).

New groups can also be added. This wishlist is used for evaluating what to focus on for future releases.

In order to know the general interest of a feature, you can also vote for features. Just add an * in parenthesis behind the feature, and please only add one...

to_did Accounting Field

Fri, 24 Mar 2006 11:30:26 +0100

Name:
to_did

Formatting Character:
D

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

Domain ID of the destination domain.

Long Description:

This field contains the domain ID of the destination domain of the request. Domain ID is a unique identifier assigned to every virtual domain handled by SERi in multi-domain mode. Domain ID is not necessarily same as the host part of the URIi in Request-URIi or To header field.

request_timestamp Accounting Field

Thu, 23 Mar 2006 16:45:37 +0100

Name:
request_timestamp

Formatting Character:
x

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:
The timestamp of SIP request arrival.

Long Description:

When used this field contains the timestamp of the SIP request arrival. The time is in UTC.

The timestamp of the SIP request arrival is necessary if you need to calculate the duration of the call precisely. The beginning of the call is denoted by arrival of 200 OK to INVITE, response_timestamp field contains the timestamp of 200 OK to INVITE.

The end of the call, however, is denoted by the arrival of BYE request. It does not matter if and when a final reply to BYE comes. BYE request cannot be refused and you typicaly want to terminate the call at the same time you hang up the receiver on your SIP phone, and this is the time when your SIP phone generates BYE.

digest_username Accounting Field

Thu, 23 Mar 2006 16:23:13 +0100

Name:
digest_username

Formatting Character:
u

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

Username from verified digest credentials.

Long Description:

If the SIP message contained digest credentials and the credentials have been successfuly verified, that means www_authenticate or proxy_authenticate was successful, then this field will contain the username parameter from the credentials. Digest credentials that have not been succesfuly verified by SERi are ignored, that means that if the SIP request contained digest credentials but you did call neither www_authenticate nor proxy_authenticate then this field will be either empty or missing.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07
To: <sip:callee@iptel.org>
Call-ID: r10815e0-bf17@127.0.0.1
CSeqi: 2 INVITE
Contact: <sip:127.0.0.1:5060>
Proxy-Authorization: Digest username="caller", realm="iptel.org", uri="sip:callee@iptel.org",
nonce="3cef753900000001771328f5ae1b8b7f0d742da1feb5753c",
response="53fe98db10e1074b03b3e06438bda70f"
Content-Type: application/sdp

sip_to Accounting Field

Thu, 23 Mar 2006 16:15:18 +0100

Name:
sip_to

Formatting Character:
t

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

The entire body of To header field.

Long Description:

sip_to accounting record contains the entire From header field body, including the name part, SIP URIi and all URI and header field parameters. This field is useful mainly for presentation, for example, in the list of missed or placed calls. There you might want to show users even the name of the caller, which is usualy present in the name part. The value of this header field is not suitable for machine processing because it contains the header field body unparsed. If you need just SIP URI from the header field or the value of the tagi parameter then you can use from_uri and from_tag accounting fields instead.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07
To: <sip:callee@iptel.org>

from_tag Accounting Field

Thu, 23 Mar 2006 16:07:58 +0100

Name:
from_tag

Formatting Character:
r

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

The value of the tagi parameter in From header field.

Long Description:

This field contains the value of tagi parameter in From header field in the SIP request. The value of From tag parameter along with Call-ID and To tag is used to match transactionsi that belong to the same call.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07

source_ip Accounting Field

Thu, 23 Mar 2006 15:55:18 +0100

Name:
source_ip

Formatting Character:
p

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

The source IP of SIP request.

Long Description:

This field contains the source IP of the datagram carrying the SIP request. This is either the IP of the user agent that generated the request or NATi.

outbound_ruri Accounting Field

Thu, 23 Mar 2006 15:51:56 +0100

Name:
outbound_ruri

Formatting Character:
o

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:
The Request-URIi i of outbound SIP request.

Long Description:

This field contains the URIi which will be present in the Request-URIi of the outgoing SIP request, that is the final Request-URI after all changes and modifications done during the routing process in SERi.

sip_method Accounting Field

Thu, 23 Mar 2006 15:42:26 +0100

Name:
sip_method

Formatting Character:
m

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:
SIP request method.

Long Description:

This field contains the method of the SIP request that created the transactioni being reported.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07

inbound_ruri Accounting Field

Thu, 23 Mar 2006 15:25:00 +0100

Name:
inbound_ruri

Formatting Character:
i

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:
The Request-URIi i of incoming SIP request.

Long Description:

This fields contains the URIi that was present in the Request-URIi of the incoming SIP request. This is the original value before it gets rewritten by SERi during the routing process.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07
To: <sip:callee@iptel.org>
Call-ID: r10815e0-bf17@127.0.0.1
CSeqi: 2 INVITE
Contact: <sip:127.0.0.1:5060>
Proxy-Authorization: Digest username="caller", realm="iptel.org",
    uri="sip:callee@iptel.org",
    nonce="3cef753900000001771328f5ae1b8b7f0d742da1feb5753c",
    response="53fe98db10e1074b03b3e06438bda70f"
Content-Type: application/sdp

flags Accounting Field

Thu, 23 Mar 2006 15:10:11 +0100

Name:
flags

Formatting Character:
g

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:
The value of SERi flags.

Long Description:

This accounting record field contains the state of various SERi flags. Each SER flag is represented by one bit in a 32-bit integer variable. This fields then contains the value of that integer variable.

sip_from Accounting Field

Thu, 23 Mar 2006 14:33:00 +0100

Name:
sip_from

Formatting Character:
f

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

The field contains the body of From header field.

Long Description:

sip_from accounting record contains the entire From header field body, including the name part, SIP URIi and all URI and header field parameters. This field is useful mainly for presentation, for example, in the list of missed or placed calls. There you might want to show users even the name of the caller, which is usualy present in the name part. The value of this header field is not suitable for machine processing because it contains the header field body unparsed. If you need just SIP URI from the header field or the value of the tagi parameter then you can use from_uri and from_tag accounting fields instead.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07

to_tag Accounting Field

Thu, 23 Mar 2006 14:29:28 +0100

Name:
to_tag

Formatting Character:
d

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

The value of tagi parameter from To header field.

Long Description:

This accounting record field contains the value of the tagi parameter from To header field. Because the original request that creates the dialogi or transactioni does not contain tag parameter in To header field, the value of this field is extracted from the finaly reply. The value of this field is used to match INVITE and BYE transactionsi that belong to the same call.

sip_callid Accounting Field

Thu, 23 Mar 2006 14:24:24 +0100

Name:
sip_callid

Formatting Character:
c

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

Field containing Call-ID value.

Long Description:

This accounting record field contains the value of the SIP Call-ID
header field. Recording of this field is enabled by default.

The value of Call-ID header field is used to match the INVITE
transactioni that denotes start of the call and corresponding BYE
transaction which terminates the call. The value of this attribute is
same in both transactionsi. Message excerpt that this attribute will
contain is highlighed in the example message below.

Example:

INVITE sip:callee@iptel.org SIP/2.0
Via: SIP/2.0/UDP 127.0.0.1:5060
Max-Forwards: 70
From: "Caller" <sip:caller@iptel.org>;tagi=76ff7a07
To: <sip:callee@iptel.org>

Attr Accounting Field

Thu, 23 Mar 2006 14:06:29 +0100

Name:
attr

Formatting Character:
a

Available in acc_db:
Yes

Available in acc_radius:
Yes

Available in acc_syslog:
Yes

Short description:

Values of selected SERi attributes.

Long Description:

When used this accounting record field contains the value of selected SERi attributes. The format of the field is a comma separated list of attribute names and attribute values. The name of attributes to be recorded can be configured using attrs module parameter of the accounting module.