CDR File Module

From Yate Documentation
Jump to: navigation, search

This module is used to write the CDRs(call detail record) into a file. The configuration file is cdrfile.conf.

Cdrfile is a module that receives a call.cdr message (maybe from cdrbuild).


The configuration file

The file used in configuration is cdrfile.conf.

Section [general]

  • file: string: Name of the file to write the CDR to
You should check that this file is log rotated - see '/etc/logrotate.d/yate'
Example: file=/var/log/yate-cdr.tsv
  • tabs: bool: Use tab-separated instead of comma-separated if format is missing.
  • combined: bool: Use combined CDR for all legs of a call.
  • format: string: Custom format to use, overrides default.
Each ${parameter} is replaced with the value of that parameter in the call.cdr message.
Below are listed the format defaults for each mode combination:
  • tab-separated (.tsv), combined=false
format=${time} ${billid} ${chan} ${address} ${caller} ${called} ${billtime} ${ringtime} ${duration} ${direction} ${status} {reason}
  • tab-separated (.tsv), combined=true
format=${time} ${billid} ${chan} ${address} ${caller} ${called} ${billtime} ${ringtime} ${duration} ${status} ${reason} ${out_leg.chan}
${out_leg.address} ${out_leg.billtime} ${out_leg.ringtime} ${out_leg.duration} ${out_leg.reason}
  • comma-separated (.csv), combined=false
  • comma-separated (.csv), combined=true

List of available variables that could be used to construct a CDR record

Note: in order for a parameter to be available in the CDR, it has to be enabled in cdrbuild.conf.

The "cdrwrite" parameter is special, a boolean value of false will prevent the CDR from being written. This is to avoid generating CDR records for utility channels while still being able to track them.

  • ${time} - UNIX time
  • ${billid} - billing record id
  • ${chan} - channel used
  • ${address} - destination address
  • ${caller} - username/number of the device that initiated/received the call
  • ${called} - destination number
  • ${callername} - caller id
  • ${billtime} - billable call duration, starts from the point when the remote party actually answers the call
  • ${ringtime} - amount of time the call was in ring state, from first ring to answer or hangup
  • ${duration} - total time of the call
  • ${direction} - has a value of outgoing or incoming
  • ${status} - disposition of the call
  • ${reason} - reason for call disconnection
  • ${out_leg.chan} - outgoing call leg channel used
  • ${out_leg.address} - the destination address for outgoing call leg
  • ${out_leg.billtime} - the billable outgoing call leg duration
  • ${out_leg.ringtime} - ring time of the outgoing call leg
  • ${out_leg.duration} - total time of the outgoing call leg
  • ${out_leg.reason} - reason for outgoing call leg disconnection

Usage example

Set CDR billing

In many real-life situations CDR billing is done in seconds.

It's useful to set:



Write CDR to file

1) Write CDRs with combined set on false and the format below:



To see the CDRs, open file /var/log/yate-cdr.csv


2) Write CDRs with combined set on true and the format for CDR:

; comma-separated (.csv), combined=true

To see the CDRs, open file /var/log/yate-cdr.csv


Converting call time

If you need a human and machine readable representation of the time column you can use the following AWK script:

awk 'BEGIN{FS=",";OFS=","} {$1=strftime("%Y%m%d%H%M%S",$1); print $0}' /var/log/yate-cdr.csv

The above assumes comma-separated format, the ${time} parameter is in the first column (the $1 positional parameter) and the CDR file is in its usual place.

Adapt the script as needed. You can make the date/time more readable by inserting separators in the time format:

awk 'BEGIN{FS=",";OFS=","} {$1=strftime("%Y-%m-%d %H:%M:%S",$1); print $0}' /var/log/yate-cdr.csv
2014-01-10 18:32:53,"1389371436-1","sip/1","","103","104",43,20,63,"incoming","answered",""
2014-01-10 18:32:53,"1389371436-1","sip/2","","103","104",43,20,63,"outgoing","answered",""

See also

Personal tools