331b6ed9a8c0adf677fb33759f8d61160ba0e352
[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 the CDR batch mode, where instead of posting the CDR at the end of
17 ; every call, the data will be stored in a buffer to help alleviate load on the
18 ; asterisk server.  Default is "no".
19 ;
20 ; WARNING WARNING WARNING
21 ; Use of batch mode may result in data loss after unsafe asterisk termination
22 ; ie. software crash, power failure, kill -9, etc.
23 ; WARNING WARNING WARNING
24 ;
25 ;batch=no
26
27 ; Define the maximum number of CDRs to accumulate in the buffer before posting
28 ; them to the backend engines.  'batch' must be set to 'yes'.  Default is 100.
29 ;size=100
30
31 ; Define the maximum time to accumulate CDRs in the buffer before posting them
32 ; to the backend engines.  If this time limit is reached, then it will post the
33 ; records, regardless of the value defined for 'size'.  'batch' must be set to
34 ; 'yes'.  Note that time is in seconds.  Default is 300 (5 minutes).
35 ;time=300
36
37 ; The CDR engine uses the internal asterisk scheduler to determine when to post
38 ; records.  Posting can either occure inside the scheduler thread, or a new
39 ; thread can be spawned for the submission of every batch.  For small batches,
40 ; it might be acceptable to just use the scheduler thread, so set this to "yes".
41 ; For large batches, say anything over size=10, a new thread is recommended, so
42 ; set this to "no".  Default is "no".
43 ;scheduleronly=no
44
45 ; When shutting down asterisk, you can block until the CDRs are submitted.  If
46 ; you don't, then data will likely be lost.  You can always check the size of
47 ; the CDR batch buffer with the CLI "cdr status" command.  To enable blocking on
48 ; submission of CDR data during asterisk shutdown, set this to "yes".  Default
49 ; is "yes".
50 ;safeshutdown=yes
51