Merged revisions 332756 via svnmerge from
[asterisk/asterisk.git] / configs / cdr.conf.sample
1 ;
2 ; Asterisk Call Detail Record engine configuration
3 ;
4 ; CDR is Call Detail Record, which provides logging services via a variety of
5 ; pluggable backend modules.  Detailed call information can be recorded to
6 ; databases, files, etc.  Useful for billing, fraud prevention, compliance with
7 ; Sarbanes-Oxley aka The Enron Act, QOS evaluations, and more.
8 ;
9
10 [general]
11
12 ; Define whether or not to use CDR logging.  Setting this to "no" will override
13 ; any loading of backend CDR modules.  Default is "yes".
14 ;enable=yes
15
16 ; Define whether or not to log unanswered calls. Setting this to "yes" will
17 ; report every attempt to ring a phone in dialing attempts, when it was not
18 ; answered. For example, if you try to dial 3 extensions, and this option is "yes",
19 ; you will get 3 CDR's, one for each phone that was rung. Default is "no". Some
20 ; find this information horribly useless. Others find it very valuable. Note, in "yes"
21 ; mode, you will see one CDR, with one of the call targets on one side, and the originating
22 ; channel on the other, and then one CDR for each channel attempted. This may seem
23 ; redundant, but cannot be helped.
24 ;
25 ; In brief, this option controls the reporting of unanswered calls which only have an A 
26 ; party. Calls which get offered to an outgoing line, but are unanswered, are still 
27 ; logged, and that is the intended behaviour. (It also results in some B side CDRs being
28 ; output, as they have the B side channel as their source channel, and no destination 
29 ; channel.)
30 ;unanswered = no
31
32 ; Normally, CDR's are not closed out until after all extensions are finished
33 ; executing.  By enabling this option, the CDR will be ended before executing
34 ; the "h" extension so that CDR values such as "end" and "billsec" may be
35 ; retrieved inside of of this extension.  The default value is "no".
36 ;endbeforehexten=no
37
38 ; Normally, the 'billsec' field logged to the backends (text files or databases)
39 ; is simply the end time (hangup time) minus the answer time in seconds. Internally,
40 ; asterisk stores the time in terms of microseconds and seconds. By setting
41 ; initiatedseconds to 'yes', you can force asterisk to report any seconds
42 ; that were initiated (a sort of round up method). Technically, this is
43 ; when the microsecond part of the end time is greater than the microsecond
44 ; part of the answer time, then the billsec time is incremented one second.
45 ; The default value is "no".
46 ;initiatedseconds=no
47
48 ; Define the CDR batch mode, where instead of posting the CDR at the end of
49 ; every call, the data will be stored in a buffer to help alleviate load on the
50 ; asterisk server.  Default is "no".
51 ;
52 ; WARNING WARNING WARNING
53 ; Use of batch mode may result in data loss after unsafe asterisk termination
54 ; ie. software crash, power failure, kill -9, etc.
55 ; WARNING WARNING WARNING
56 ;
57 ;batch=no
58
59 ; Define the maximum number of CDRs to accumulate in the buffer before posting
60 ; them to the backend engines.  'batch' must be set to 'yes'.  Default is 100.
61 ;size=100
62
63 ; Define the maximum time to accumulate CDRs in the buffer before posting them
64 ; to the backend engines.  If this time limit is reached, then it will post the
65 ; records, regardless of the value defined for 'size'.  'batch' must be set to
66 ; 'yes'.  Note that time is in seconds.  Default is 300 (5 minutes).
67 ;time=300
68
69 ; The CDR engine uses the internal asterisk scheduler to determine when to post
70 ; records.  Posting can either occur inside the scheduler thread, or a new
71 ; thread can be spawned for the submission of every batch.  For small batches,
72 ; it might be acceptable to just use the scheduler thread, so set this to "yes".
73 ; For large batches, say anything over size=10, a new thread is recommended, so
74 ; set this to "no".  Default is "no".
75 ;scheduleronly=no
76
77 ; When shutting down asterisk, you can block until the CDRs are submitted.  If
78 ; you don't, then data will likely be lost.  You can always check the size of
79 ; the CDR batch buffer with the CLI "cdr status" command.  To enable blocking on
80 ; submission of CDR data during asterisk shutdown, set this to "yes".  Default
81 ; is "yes".
82 ;safeshutdown=yes
83
84 ;
85 ;
86 ; CHOOSING A CDR "BACKEND"  (what kind of output to generate)
87 ;
88 ; To choose a backend, you have to make sure either the right category is
89 ; defined in this file, or that the appropriate config file exists, and has the
90 ; proper definitions in it. If there are any problems, usually, the entry will
91 ; silently ignored, and you get no output.
92 ;
93 ; Also, please note that you can generate CDR records in as many formats as you
94 ; wish. If you configure 5 different CDR formats, then each event will be logged
95 ; in 5 different places! In the example config files, all formats are commented
96 ; out except for the cdr-csv format.
97 ;
98 ; Here are all the possible back ends:
99 ;
100 ;   csv, custom, manager, odbc, pgsql, radius, sqlite, tds
101 ;    (also, mysql is available via the asterisk-addons, due to licensing
102 ;     requirements)
103 ;   (please note, also, that other backends can be created, by creating
104 ;    a new backend module in the source cdr/ directory!)
105 ;
106 ; Some of the modules required to provide these backends will not build or install
107 ; unless some dependency requirements are met. Examples of this are pgsql, odbc,
108 ; etc. If you are not getting output as you would expect, the first thing to do
109 ; is to run the command "make menuselect", and check what modules are available,
110 ; by looking in the "2. Call Detail Recording" option in the main menu. If your
111 ; backend is marked with XXX, you know that the "configure" command could not find
112 ; the required libraries for that option.
113 ;
114 ; To get CDRs to be logged to the plain-jane /var/log/asterisk/cdr-csv/Master.csv
115 ; file, define the [csv] category in this file. No database necessary. The example
116 ; config files are set up to provide this kind of output by default.
117 ;
118 ; To get custom csv CDR records, make sure the cdr_custom.conf file
119 ; is present, and contains the proper [mappings] section. The advantage to
120 ; using this backend, is that you can define which fields to output, and in
121 ; what order. By default, the example configs are set up to mimic the cdr-csv
122 ; output. If you don't make any changes to the mappings, you are basically generating
123 ; the same thing as cdr-csv, but expending more CPU cycles to do so!
124 ;
125 ; To get manager events generated, make sure the cdr_manager.conf file exists,
126 ; and the [general] section is defined, with the single variable 'enabled = yes'.
127 ;
128 ; For odbc, make sure all the proper libs are installed, that "make menuselect"
129 ; shows that the modules are available, and the cdr_odbc.conf file exists, and
130 ; has a [global] section with the proper variables defined.
131 ;
132 ; For pgsql, make sure all the proper libs are installed, that "make menuselect"
133 ; shows that the modules are available, and the cdr_pgsql.conf file exists, and
134 ; has a [global] section with the proper variables defined.
135 ;
136 ; For logging to radius databases, make sure all the proper libs are installed, that
137 ; "make menuselect" shows that the modules are available, and the [radius]
138 ; category is defined in this file, and in that section, make sure the 'radiuscfg'
139 ; variable is properly pointing to an existing radiusclient.conf file.
140 ;
141 ; For logging to sqlite databases, make sure the 'cdr.db' file exists in the log directory,
142 ; which is usually /var/log/asterisk. Of course, the proper libraries should be available
143 ; during the 'configure' operation.
144 ;
145 ; For tds logging, make sure the proper libraries are available during the 'configure'
146 ; phase, and that cdr_tds.conf exists and is properly set up with a [global] category.
147 ;
148 ; Also, remember, that if you wish to log CDR info to a database, you will have to define
149 ; a specific table in that databse to make things work! See the doc directory for more details
150 ; on how to create this table in each database.
151 ;
152
153 [csv]
154 usegmtime=yes    ; log date/time in GMT.  Default is "no"
155 loguniqueid=yes  ; log uniqueid.  Default is "no"
156 loguserfield=yes ; log user field.  Default is "no"
157 accountlogs=yes  ; create separate log file for each account code. Default is "yes"
158
159 ;[radius]
160 ;usegmtime=yes    ; log date/time in GMT
161 ;loguniqueid=yes  ; log uniqueid
162 ;loguserfield=yes ; log user field
163 ; Set this to the location of the radiusclient-ng configuration file
164 ; The default is /etc/radiusclient-ng/radiusclient.conf
165 ;radiuscfg => /usr/local/etc/radiusclient-ng/radiusclient.conf