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