cdr.conf.sample 8.4 KB

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