update the dump of application docs
[asterisk/asterisk.git] / doc / queuelog.tex
1 In order to properly manage ACD queues, it is important to be able to
2 keep track of details of call setups and teardowns in much greater detail
3 than traditional call detail records provide.  In order to support this,
4 extensive and detailed tracing of every queued call is stored in the
5 queue log, located (by default) in /var/log/asterisk/queue\_log.
6
7 These are the events (and associated information) in the queue log:
8
9 ABANDON(position|origposition|waittime)
10 The caller abandoned their position in the queue.  The position is the
11 caller's position in the queue when they hungup, the origposition is
12 the original position the caller was when they first entered the
13 queue, and the waittime is how long the call had been waiting in the 
14 queue at the time of disconnect.
15
16 AGENTDUMP
17 The agent dumped the caller while listening to the queue announcement.
18
19 AGENTLOGIN(channel)
20 The agent logged in.  The channel is recorded.
21
22 AGENTCALLBACKLOGIN(exten@context)
23 The callback agent logged in.  The login extension and context is recorded.
24
25 AGENTLOGOFF(channel|logintime)
26 The agent logged off.  The channel is recorded, along with the total time
27 the agent was logged in.
28
29 AGENTCALLBACKLOGOFF(exten@context|logintime|reason)
30 The callback agent logged off.  The last login extension and context is
31 recorded, along with the total time the agent was logged in, and the
32 reason for the logoff if it was not a normal logoff 
33 (e.g., Autologoff, Chanunavail)
34
35 COMPLETEAGENT(holdtime|calltime|origposition)
36 The caller was connected to an agent, and the call was terminated normally
37 by the *agent*.  The caller's hold time and the length of the call are both
38 recorded.  The caller's original position in the queue is recorded in
39 origposition.
40
41 COMPLETECALLER(holdtime|calltime|origposition)
42 The caller was connected to an agent, and the call was terminated normally
43 by the *caller*.  The caller's hold time and the length of the call are both
44 recorded.  The caller's original position in the queue is recorded in
45 origposition.
46
47 CONFIGRELOAD
48 The configuration has been reloaded (e.g. with asterisk -rx reload)
49
50 CONNECT(holdtime|bridgedchanneluniqueid)
51 The caller was connected to an agent.  Hold time represents the amount
52 of time the caller was on hold. The bridged channel unique ID contains
53 the unique ID of the queue member channel that is taking the call. This
54 is useful when trying to link recording filenames to a particular
55 call in the queue.
56
57 ENTERQUEUE(url|callerid)
58 A call has entered the queue.  URL (if specified) and Caller*ID are placed
59 in the log.
60
61 EXITEMPTY(position|origposition|waittime)
62 The caller was exited from the queue forcefully because the queue had no
63 reachable members and it's configured to do that to callers when there
64 are no reachable members. The position is the caller's position in the
65 queue when they hungup, the origposition is the original position the 
66 caller was when they first entered the queue, and the waittime is how 
67 long the call had been waiting in the queue at the time of disconnect.
68
69 EXITWITHKEY(key|position|origposition|waittime)
70 The caller elected to use a menu key to exit the queue.  The key and
71 the caller's position in the queue are recorded.  The caller's entry
72 position and amoutn of time waited is also recorded.
73
74 EXITWITHTIMEOUT(position|origposition|waittime)
75 The caller was on hold too long and the timeout expired.  The position in the
76 queue when the timeout occurred, the entry position, and the amount of time
77 waited are logged.
78
79 QUEUESTART
80 The queueing system has been started for the first time this session.
81
82 RINGNOANSWER(ringtime)
83 After trying for ringtime ms to connect to the available queue member,
84 the attempt ended without the member picking up the call. Bad queue
85 member!
86
87 SYSCOMPAT
88 A call was answered by an agent, but the call was dropped because the 
89 channels were not compatible.
90
91 TRANSFER(extension|context|holdtime|calltime)
92 Caller was transferred to a different extension.  Context and extension
93 are recorded. The caller's hold time and the length of the call are both
94 recorded. PLEASE remember that transfers performed by SIP UA's by way
95 of a reinvite may not always be caught by Asterisk and trigger off this
96 event. The only way to be 100\% sure that you will get this event when
97 a transfer is performed by a queue member is to use the built-in transfer
98 functionality of Asterisk.
99