Add common headers to CEL related configs.
[asterisk/asterisk.git] / configs / cel.conf.sample
1 ;
2 ; Asterisk Channel Event Logging (CEL)
3 ;
4
5 ; Channel Event Logging is a mechanism to provide fine-grained event information
6 ; that can be used to generate billing information. Such event information can
7 ; be recorded to databases and files via pluggable backend modules.
8 ;
9
10 [general]
11
12 ; CEL Activation
13 ;
14 ; Use the 'enable' keyword to turn CEL on or off.
15 ;
16 ; Accepted values: yes and no
17 ; Default value:   no
18
19 ;enable=yes
20
21 ; Application Tracking
22 ;
23 ; Use the 'apps' keyword to specify the list of applications for which you want
24 ; to receive CEL events.  This is a comma separated list of Asterisk dialplan
25 ; applications, such as Dial, Queue, and Park.
26 ;
27 ; Accepted values: A comma separated list of Asterisk dialplan applications
28 ; Default value:   none
29 ;
30 ; Note: You may also use 'all' which will result in CEL events being reported
31 ;       for all Asterisk applications.  This may affect Asterisk's performance
32 ;       significantly.
33
34 apps=dial,park
35
36 ; Event Tracking
37 ;
38 ; Use the 'events' keyword to specify the list of events which you want to be
39 ; raised when they occur.  This is a comma separated list of the values in the
40 ; table below.
41 ;
42 ; Accepted values: A comma separated list of one or more of the following:
43 ;  ALL              -- Generate entries on all events
44 ;  CHAN_START       -- The time a channel was created
45 ;  CHAN_END         -- The time a channel was terminated
46 ;  ANSWER           -- The time a channel was answered (ie, phone taken off-hook)
47 ;  HANGUP           -- The time at which a hangup occurred
48 ;  CONF_ENTER       -- The time a channel was connected into a conference room
49 ;  CONF_EXIT        -- The time a channel was removed from a conference room
50 ;  CONF_START       -- The time the first person enters a conference room
51 ;  CONF_END         -- The time the last person left a conference room (and
52 ;                      turned out the lights?)
53 ;  APP_START        -- The time a tracked application was started
54 ;  APP_END          -- the time a tracked application ended
55 ;  PARK_START       -- The time a call was parked
56 ;  PARK_END         -- Unpark event
57 ;  BRIDGE_START     -- The time a bridge is started
58 ;  BRIDGE_END       -- The time a bridge is ended
59 ;  3WAY_START       -- When a 3-way conference starts (usually via attended xfer)
60 ;  3WAY_END         -- When one or all exit a 3-way conference
61 ;  BLINDTRANSFER    -- When a blind transfer is initiated
62 ;  ATTENDEDTRANSFER -- When an attended transfer is initiated
63 ;  TRANSFER         -- Generic transfer initiated; not used yet...?
64 ;  HOOKFLASH        -- So far, when a hookflash event occurs on a DAHDI
65 ;                      interface
66 ;  USER_EVENT       -- Triggered from the dialplan, and has a name given by the
67 ;                      user
68 ;
69 ; Default value: none
70 ;                (Track no events)
71
72 events=APP_START,CHAN_START,CHAN_END,ANSWER,HANGUP,BRIDGE_START,BRIDGE_END
73
74 ; Date Format
75 ;
76 ; Use the 'dateformat' keyword to specify the date format used when CEL events
77 ; are raised.
78 ;
79 ; Accepted values: A strftime format string (see man strftime)
80 ;
81 ; Example: "%F %T"
82 ;  -> This gives the date and time in the format "2009-06-23 17:02:35"
83 ;
84 ; If this option is not specified, the default format is "<seconds>.<microseconds>"
85 ; since epoch.  The microseconds field will always be 6 digits in length, meaning it
86 ; may have leading zeros.
87 ;
88 ;dateformat = %F %T
89
90 ;
91 ; Asterisk Manager Interface (AMI) CEL Backend
92 ;
93
94 [manager]
95
96 ; AMI Backend Activation
97 ;
98 ; Use the 'enable' keyword to turn CEL logging to the Asterisk Manager Interface
99 ; on or off.
100 ;
101 ; Accepted values: yes and no
102 ; Default value:   no
103
104 ;enabled=yes