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