start using asterisk/network.h for network related headers.
[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 occur 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
52 ; Normally, CDR's are not closed out until after all extensions are finished
53 ; executing.  By enabling this option, the CDR will be ended before executing
54 ; the "h" extension so that CDR values such as "end" and "billsec" may be
55 ; retrieved inside of of this extension.
56 ;endbeforehexten=no
57
58 ;
59 ;
60 ; CHOOSING A CDR "BACKEND"  (what kind of output to generate)
61 ;
62 ; To choose a backend, you have to make sure either the right category is 
63 ; defined in this file, or that the appropriate config file exists, and has the 
64 ; proper definitions in it. If there are any problems, usually, the entry will
65 ; silently ignored, and you get no output.
66
67 ; Also, please note that you can generate CDR records in as many formats as you 
68 ; wish. If you configure 5 different CDR formats, then each event will be logged
69 ; in 5 different places! In the example config files, all formats are commented
70 ; out except for the cdr-csv format.
71 ;
72 ; Here are all the possible back ends:
73 ;
74 ;   csv, custom, manager, odbc, pgsql, radius, sqlite, tds 
75 ;    (also, mysql is available via the asterisk-addons, due to licensing
76 ;     requirements)
77 ;   (please note, also, that other backends can be created, by creating
78 ;    a new backend module in the source cdr/ directory!)
79 ;
80 ; Some of the modules required to provide these backends will not build or install
81 ; unless some dependency requirements are met. Examples of this are pgsql, odbc,
82 ; etc. If you are not getting output as you would expect, the first thing to do
83 ; is to run the command "make menuselect", and check what modules are available,
84 ; by looking in the "2. Call Detail Recording" option in the main menu. If your
85 ; backend is marked with XXX, you know that the "configure" command could not find
86 ; the required libraries for that option.
87 ;
88 ; To get CDRs to be logged to the plain-jane /var/log/asterisk/cdr-csv/Master.csv 
89 ; file, define the [csv] category in this file. No database necessary. The example
90 ; config files are set up to provide this kind of output by default.
91 ;
92 ; To get custom csv CDR records, make sure the cdr_custom.conf file
93 ; is present, and contains the proper [mappings] section. The advantage to
94 ; using this backend, is that you can define which fields to output, and in
95 ; what order. By default, the example configs are set up to mimic the cdr-csv
96 ; output. If you don't make any changes to the mappings, you are basically generating
97 ; the same thing as cdr-csv, but expending more CPU cycles to do so!
98 ;
99 ; To get manager events generated, make sure the cdr_manager.conf file exists,
100 ; and the [general] section is defined, with the single variable 'enabled = yes'.
101 ;
102 ; For odbc, make sure all the proper libs are installed, that "make menuselect"
103 ; shows that the modules are available, and the cdr_odbc.conf file exists, and
104 ; has a [global] section with the proper variables defined.
105 ;
106 ; For pgsql, make sure all the proper libs are installed, that "make menuselect"
107 ; shows that the modules are available, and the cdr_pgsql.conf file exists, and
108 ; has a [global] section with the proper variables defined.
109 ;
110 ; For logging to radius databases, make sure all the proper libs are installed, that 
111 ; "make menuselect" shows that the modules are available, and the [radius]
112 ; category is defined in this file, and in that section, make sure the 'radiuscfg'
113 ; variable is properly pointing to an existing radiusclient.conf file.
114 ;
115 ; For logging to sqlite databases, make sure the 'cdr.db' file exists in the log directory,
116 ; which is usually /var/log/asterisk. Of course, the proper libraries should be available
117 ; during the 'configure' operation.
118 ;
119 ; For tds logging, make sure the proper libraries are available during the 'configure' 
120 ; phase, and that cdr_tds.conf exists and is properly set up with a [global] category.
121 ;
122 ; Also, remember, that if you wish to log CDR info to a database, you will have to define
123 ; a specific table in that databse to make things work! See the doc directory for more details
124 ; on how to create this table in each database.
125 ;
126
127 [csv]
128 usegmtime=yes    ; log date/time in GMT.  Default is "no"
129 loguniqueid=yes  ; log uniqueid.  Default is "no
130 loguserfield=yes ; log user field.  Default is "no
131
132 ;[radius]
133 ;usegmtime=yes    ; log date/time in GMT
134 ;loguniqueid=yes  ; log uniqueid
135 ;loguserfield=yes ; log user field
136 ; Set this to the location of the radiusclient-ng configuration file
137 ; The default is /etc/radiusclient-ng/radiusclient.conf
138 ;radiuscfg => /usr/local/etc/radiusclient-ng/radiusclient.conf