CCP Metrics

accept

Accept

Logged whenever the <accept> tag is executed.

Format

accept <Connection Id>
Connection Id the connection id

Metrics Id: 1000

application

Application

Logged whenever a page is compiled that contains a <meta> tag with a name attribute value of "application". This is logged before the page_start metric for the page.

Format

application <Name>
Name the value of the content attribute, i.e. the application name

Metrics Id: 1001

assign

Assign

Logged whenever an <assign> tag is executed.

Format

assign <Name>|<Value>
Name the name of the variable assigned
Value the value assigned to the variable

Metrics Id: 1002

cancel

Cancel

Logged whenever the <cancel> tag is executed.

Format

cancel <Send Id>
Send Id the send id

Metrics Id: 1003

ccxml_error

CCXML Error Event

Logged whenever a ccxml error event (an event with an event source of ccxml and a name that begins with "error.") is pulled off a session's event queue.

Format

ccxml_error <Event Id>|<Event Name>|<Properties>|<Reason>
Event Id the event id
Event Name the event name
Properties a name-value pair list whose contents depend on the event type.
Reason the reason text

Metrics Id: 1004

ccxml_event

CCXML Event

Logged whenever a ccxml non-error event (an event with an event source of ccxml and a name that does not begin with "error.") is pulled off a session's event queue.

Format

ccxml_event <Event Id>|<Event Name>|<Properties>
Event Id the event id
Event Name the event name
Properties a name-value pair list whose contents depend on the event type.

Metrics Id: 1005

cond

Cond

Logged whenever the cond attribute on an <if> or <elseif> tag is evaluated.

Format

cond <Result>|<Expr>
Result the evaluation result, either "true" or "false"
Expr the cond ECMAScript

Metrics Id: 1006

conf_error

Conference Error Event

Logged whenever a conference error event (error.conference.create or error.conference.destroy) is pulled off a session's event queue.

Format

conf_error <Event Id>|<Event Name>|<Conference Id>|<Reason>
Event Id the event id
Event Name the event name
Conference Id the conferenceid
Reason the reason

Metrics Id: 1007

conf_event

Conference Event

Logged whenever a conference non-error event (conference.created or conference.destroyed) is pulled off a session's event queue.

Format

conf_event <Event Id>|<Event Name>|<Conference Id>
Event Id the event id
Event Name the event name
Conference Id the conferenceid

Metrics Id: 1008

conn_create

Connection Create

Logged whenever an outbound SIP connection is attempted.

Format

conn_create <Connection Type>|<Id>|<Response Code>|<Call Id>|<From>|<To>|<Request URI>
Connection Type the type of connection; one of: for an outbound call leg for a dialog leg for a conference leg for a conference control leg for a primary bridging server leg for a secondary bridging server leg for a bridging server control leg (note that confctrl and brgctrl are not currently used)
call for an outbound call leg
dialog for a dialog leg
confleg for a conference leg
confctrl for a conference control leg
brgprim for a primary bridging server leg
brgsec for a secondary bridging server leg
brgctrl for a bridging server control leg
Id the connectionid (for call), dialogid (for dialog) or conferenceid (for confctrl) for the SIP connection. For the conference legs, this is the joinid of the <join> associated with the conference leg.
Response Code the response code of the INVITE response, or -1 if some internal error prevented the INVITE from completing,
Call Id the Call-Id header value
From the From header value (ANI)
To the To header value (DNIS)
Request URI the SIP request URI

Metrics Id: 1009

conn_error

Connection Error Event

Logged whenever a connection error event (an event with a name that begins with "error.connection.") is pulled off a session's event queue.

Format

conn_error <Event Id>|<Event Name>|<Connection Id>|<Connection State>|<Reason>
Event Id the event id
Event Name the event name
Connection Id the connection id
Connection State the new state of the connection after the event is applied to the connection's state machine
Reason the reason

Metrics Id: 1010

conn_event

Connection Event

Logged whenever a connection non-error event (an event with a name that begins with "connection.") is pulled off a session's event queue.

Format

conn_event <Event Id>|<Event Name>|<Connection Id>|<Connection State>|<Properties>
Event Id the event id
Event Name the event name
Connection Id the connection id
Connection State the new state of the connection after the event is applied to the connection's state machine (e.g. connection.connected will yield a value of "CS_CONNECTED"); Match order of CCXMLSessionConnection::STATE
initial Match order of CCXMLSessionConnection::STATE
alerting
progressing
connected
disconnected
failed
error
Properties a name-value pair list whose contents depend on the event type.

Metrics Id: 1011

conn_reject

Connection Reject

Logged whenever a new incoming call is rejected without initiating a new session.

Format

conn_reject <Connection Id>|<Reject Reason>
Connection Id the connection id of the call
Reject Reason a reason code; one of: the system is in the suspended state and not accepting calls there are not enough licenses there is not enough info in the session request to start a new session (e.g. no initial CCXML URI) or the information contains errors (e.g. the initial URI can't be fetched) a system error occurred
suspended the system is in the suspended state and not accepting calls
nolicense there are not enough licenses
apperr there is not enough info in the session request to start a new session (e.g. no initial CCXML URI) or the information contains errors (e.g. the initial URI can't be fetched)
syserr a system error occurred

Metrics Id: 1012

conn_request

Connection Request

Logged whenever a new, incoming call is received by the CCXML platform.

Format

conn_request <Connection Id>|<Call Id>|<From>|<To>|<Request URI>
Connection Id the connection id of the call
Call Id the Call-Id header value
From the From header value (ANI)
To the To header value (DNIS)
Request URI the SIP request URI

Metrics Id: 1013

connop_error

Connection Operation Error Event

Logged whenever a connection operation error event (error.merge) is pulled off a session's event queue.

Format

connop_error <Event Id>|<Event Name>|<Connection Id 1>|<Connection Id 2>|<Reason>
Event Id the event id
Event Name the event name
Connection Id 1 the first connectionid
Connection Id 2 the second connectionid or "N/A" if none
Reason the reason text

Metrics Id: 1014

createcall

Createcall

Logged whenever the <createcall> tag is executed.

Format

createcall <Connection Id>|<Destination>|<Caller Id>|<AAI>|<Timeout>|<Endpoint Id>|<Join Direction>
Connection Id the connection id
Destination the destination URI
Caller Id the caller id URI
AAI the aai value
Timeout the timeout value
Endpoint Id connection, conference or dialog id to join to
Join Direction the join direction;
both
calltransmit
callreceive

Metrics Id: 1015

createccxml

Createccxml

Logged whenever the <createccxml> tag is executed.

Format

createccxml <New Session Id>|<URI>
New Session Id the session id of the new session
URI the URI of the CCXML page

Metrics Id: 1016

createccxml_data

Createccxml Data

Logged whenever the <createccxml> tag is executed. This contains the namelist data used, and is logged immediately after the createccxml metric.

Format

createccxml_data <New Session Id>|<Namelist>
New Session Id the session id of the new session
Namelist the namelist parameters as a name-value pair list.

Metrics Id: 1017

createccxml_details

Createccxml Details

Logged whenever the <createccxml> tag is executed. This contains extended details about the fetch, and is logged immediately after the createccxml_data metric.

Format

createccxml_details <New Session Id>|<Fetch Method>|<Timeout>|<Max-age>|<Max-stale>|<Encoding>
New Session Id the session id of the new session
Fetch Method the HTTP method ("N/A" for a file URI)
Timeout the timeout value
Max-age the maxage value
Max-stale the maxstale value
Encoding the encoding type ("N/A" for file URIs or GETs)

Metrics Id: 1018

createconference

Createconference

Logged whenever the <createconference> tag is executed.

Format

createconference <Conference Id>|<Name>
Conference Id the conference id (NOTE: this may be blank)
Name the conference name

Metrics Id: 1019

destroyconference

Destroyconference

Logged whenever the <destroyconference> tag is executed.

Format

destroyconference <Conference Id>
Conference Id the conference id

Metrics Id: 1020

dialogprepare

Dialogprepare

Logged whenever the <dialogprepare> tag is executed.

Format

dialogprepare <Dialog Id>|<URI>|<Type>|<Id>|<Media Direction>
Dialog Id the dialog id
URI the src URI
Type the MIME type
Id the connection id or conference id, whichever one is specified
Media Direction the media direction; Match order of CCXMLMediaEndpoint::DIRECTION implicit join for <createcall> implicit join for <dialogstart> implicit join for <dialogstart>
both Match order of CCXMLMediaEndpoint::DIRECTION
dialogtransmit implicit join for <createcall>
dialogreceive implicit join for <dialogstart>
none implicit join for <dialogstart>

Metrics Id: 1021

dialogprepare_data

Dialogprepare Data

Logged whenever the <dialogprepare> tag is executed. This contains the namelist data and is logged immediately after the dialogprepare metric.

Format

dialogprepare_data <Dialog Id>|<Namelist>
Dialog Id the dialog id
Namelist the namelist parameters as a name-value pair list.

Metrics Id: 1022

dialogprepare_details

Dialogprepare Details

Logged whenever the <dialogprepare> tag is executed. This contains extra details about the dialogprepare tag and is logged immediately after the dialogprepare_data metric.

Format

dialogprepare_details <Dialog Id>|<Fetch Method>|<Max-age>|<Max-stale>|<Encoding>
Dialog Id the dialog id
Fetch Method the HTTP method (or "N/A" for file URIs)
Max-age the maxage value
Max-stale the maxstale value
Encoding the encoding type ("N/A" for file URIs or GETs)

Metrics Id: 1023

dialogstart

Dialogstart

Logged whenever the <dialogstart> tag is executed.

Format

dialogstart <Dialog Id>|<URI>|<Type>|<Endpoint Id>|<Media Direction>|<Join id>
Dialog Id the dialog id
URI the src URI
Type the MIME type
Endpoint Id the connection id or conference id, whichever one is specified
Media Direction the media direction
Join id the internal join id for the implicit join

Metrics Id: 1024

dialogstart_data

Dialogstart Data

Logged whenever the <dialogstart> tag is executed. This contains the namelist data and is logged immediately after the dialogstart metric.

Format

dialogstart_data <Dialog Id>|<Namelist>
Dialog Id the dialog id
Namelist the first 8 namelist parameters are logged as a name-value pair list.

Metrics Id: 1025

dialogstart_details

Dialogstart Details

Logged whenever the <dialogstart> tag is executed. This contains extra details about the dialogstart tag and is logged immediately after the dialogstart_data metric.

Format

dialogstart_details <Dialog Id>|<Fetch Method>|<Max-age>|<Max-stale>|<Encoding>
Dialog Id the dialog id
Fetch Method the HTTP method (or "N/A" for file URIs)
Max-age the maxage value
Max-stale the maxstale value
Encoding the encoding type ("N/A" for file URIs or GETs)

Metrics Id: 1026

dialogterminate

Dialogterminate

Logged whenever the <dialogterminate> tag is executed.

Format

dialogterminate <Dialog Id>|<Immediate Mode>
Dialog Id the dialog id
Immediate Mode immediate mode indicator;
immediate
normal

Metrics Id: 1027

disconnect

Disconnect

Logged whenever the <disconnect> tag is executed.

Format

disconnect <Connection Id>|<Reason>
Connection Id the connection id
Reason the reason text

Metrics Id: 1028

dlg_error

Dialog Error Event

Logged whenever a dialog error event (an event with a name that begins with "error.dialog.") is pulled off a session's event queue.

Format

dlg_error <Event Id>|<Event Name>|<Dialog Id>|<Reason>
Event Id the event id
Event Name the event name
Dialog Id the dialogid
Reason the reason

Metrics Id: 1029

dlg_event

Dialog Event

Logged whenever a dialog non-error event (an event with a name that begins with "dialog.") is pulled off a session's event queue.

Format

dlg_event <Event Id>|<Event Name>|<Dialog Id>|<Properties>
Event Id the event id
Event Name the event name
Dialog Id the dialogid
Properties a name-value pair list whose contents depend on the event type.

Metrics Id: 1030

end_session

End Session

Logged whenever a CCXML session ends.

Format

end_session <Session End Reason>
Session End Reason the reason the session ended; one of: the <exit> tag was executed the session was killed by a ccxml.kill.unconditional event or an unhandled ccxml.kill event. the session ended because an eror was encountered during document initialization the session was ended by an unhandled error.* event. the session aborted due to an internal error.
exit the <exit> tag was executed
kill the session was killed by a ccxml.kill.unconditional event or an unhandled ccxml.kill event.
docinit the session ended because an eror was encountered during document initialization
error the session was ended by an unhandled error.* event.
syserr the session aborted due to an internal error.

Metrics Id: 1031

error

Error Event

Logged whenever an error event (it begins with "error.") is pulled off a session's event queue and it is not logged as part of any log event described in TRD.MRG.20.*.

Format

error <Event Id>|<Event Name>|<Source Type>|<Source>|<Reason>
Event Id the event id
Event Name the event name
Source Type the event source type
Source the event source
Reason the reason

Metrics Id: 1032

event

Generic Event

Logged whenever a non-error event (it does not begin with "error.") is pulled off a session's event queue and it is not logged as part of any log event described in TRD.MRG.20.*.

Format

event <Event Id>|<Event Name>|<Source Type>|<Source>
Event Id the event id
Event Name the event name
Source Type the event source type
Source the event source

Metrics Id: 1033

exit

Exit

Logged whenever the <exit> tag is executed.

Format

exit <Expr>
Expr the expr value ("undefined" if not specified)

Metrics Id: 1034

exit_data

Exit Data

Logged whenever the <exit> tag is executed. This is logged immediately after the exit metric.

Format

exit_data <Namelist>
Namelist the namelist parameters as a name-value pair list.

Metrics Id: 1035

fetch

Fetch

Logged whenever the <fetch> tag is executed.

Format

fetch <Fetch Id>|<URI>|<Type>
Fetch Id the fetch id
URI the next URI
Type the MIME type

Metrics Id: 1036

fetch_data

Fetch Data

Logged whenever the <fetch> tag is executed. This contains the namelist data used in the fetch, and is logged immediately after the fetch metric.

Format

fetch_data <Fetch Id>|<Namelist>
Fetch Id the fetch id
Namelist the namelist parameters as a name-value pair list.

Metrics Id: 1037

fetch_details

Fetch Details

Logged whenever the <fetch> tag is executed. This contains extended details about the fetch, and is logged immediately after the fetch_data metric.

Format

fetch_details <Fetch Id>|<Fetch Method>|<Type>|<Timeout>|<Max-age>|<Max-stale>|<Encoding>
Fetch Id the fetch id
Fetch Method the HTTP method ("N/A" for a file URI)
Type the MIME type
Timeout the timeout value
Max-age the maxage value
Max-stale the maxstale value
Encoding the encoding type ("N/A" for file URIs or GETs)

Metrics Id: 1038

fetch_req

Fetch Request

Logged whenever a resource is fetched using either http, https or file URIs.

Format

fetch_req <Fetch Type>|<Id>|<Fetch Method>|<URI>
Fetch Type the type of fetch. One of: for initial CCXML pages for referenced scripts in initial CCXML pages for fetched CCXML pages for referenced scripts in fetched CCXML pages for fetched scripts for sent http I/O events
initial for initial CCXML pages
initial_script for referenced scripts in initial CCXML pages
fetch_ccxml for fetched CCXML pages
ref_script for referenced scripts in fetched CCXML pages
fetch_script for fetched scripts
send for sent http I/O events
Id the id of the fetch. The exact value used depends on the type of the fetch as follows: the session id the session id the fetch id the fetch id of the CCXML page the fetch id the send id
initial the session id
initial_script the session id
fetch_ccxml the fetch id
ref_script the fetch id of the CCXML page
fetch_script the fetch id
send the send id
Fetch Method the HTTP method used; denoted by: GET method POST method method was not specified
get GET method
post POST method
none method was not specified
URI the URI fetched

Metrics Id: 1039

fetch_resp

Fetch Response

Logged whenever a resource fetch completes.

Format

fetch_resp <Fetch Type>|<Id>|<Success Indicator>|<Failure Code>|<Fetch Origin>|<URI>
Fetch Type the type of fetch. (Defined as in fetch_req)
Id the id of the fetch (Defined as in fetch_req)
Success Indicator success indicator;
success
failure
Failure Code On failure, the HTTP response code or -1 if the request timed out
Fetch Origin On success, an indicator as to the origin of the file; denoted by: the resource was found in the fetching module memory cache the resource was found in the proxy cache the resource was not found in the proxy cache and a request was made the proxy was bypassed and a direct request was made the resource was a file URI the compiled object was found in the document manager
memory the resource was found in the fetching module memory cache
cache_hit the resource was found in the proxy cache
cache_miss the resource was not found in the proxy cache and a request was made
direct the proxy was bypassed and a direct request was made
file the resource was a file URI
object the compiled object was found in the document manager
URI the URI received (may be different than the one fetched if the request was redirected)

Metrics Id: 1040

goto

Goto

Logged whenever the <goto> tag is executed.

Format

goto <Fetch Id>
Fetch Id the fetch id

Metrics Id: 1041

join

Join

Logged whenever the <join> tag is executed, or an implicit join is invoked by a <createcall> or <dialogstart>.

Format

join <Endpoint Id 1>|<Endpoint Id 2>|<Duplex Mode>|<Join Id>|<Join Type>
Endpoint Id 1 the first id (for implicit joins this is the new call or dialog)
Endpoint Id 2 the second id
Duplex Mode the duplex value;
full
half
Join Id the internal join id that identifies the join
Join Type the type of join: using <join> element implicit join for <createcall> implicit join for <dialogstart>
join using <join> element
createcall implicit join for <createcall>
dialogstart implicit join for <dialogstart>

Metrics Id: 1042

join_error

Join Error Event

Logged whenever a join error event (error.conference.join and error.conference.unjoin) is pulled off a session's event queue.

Format

join_error <Event Id>|<Event Name>|<Endpoint 1>|<Endpoint 2>|<Join Id>|<Reason>
Event Id the event id
Event Name the event name
Endpoint 1 the id of the first joined party
Endpoint 2 the id of the second joined party
Join Id the internal join id for the join/unjoin
Reason the reason

Metrics Id: 1043

join_event

Join Event

Logged whenever a join non-error event (conference.joined and conference.unjoined) is pulled off a session's event queue.

Format

join_event <Event Id>|<Event Name>|<Endpoint 1>|<Endpoint 2>|<Join Id>
Event Id the event id
Event Name the event name
Endpoint 1 the id of the first joined party
Endpoint 2 the id of the second joined party
Join Id the internal join id for the join/unjoin (may be 0 for unjoins caused by disconnects etc.)

Metrics Id: 1044

log

Log

Logged whenever the <log> tag is executed.

Format

log <Label>|<Text>
Label the log label
Text the log text

Metrics Id: 1045

media_end

Media End

Logged whenever an SDP media line that was previously active becomes inactive (e.g. it is assigned a 0 port for offer-answer, put on hold, removed, or simply not part of a join).

Format

media_end <Call Id>|<Join Id>
Call Id the SIP Call-Id
Join Id the internal join id of the (explicit or implicit) join that initiated this media line. This has the special value of "brdgsrv" for the media line joining an endpoint with its bridging server.

Metrics Id: 1046

media_upd

Media Update

Logged whenever an active (e.g. not 0 port for offer-answer, or hold SDP) SDP media line is negotiated with a SIP connection. This includes the first offer or answer that includes that media line as well as subsequent re-INVITEs that include the media line.

Format

media_upd <Call Id>|<Join Id>|<Type>|<IP>|<Port>|<Directionality>|<Codecs>
Call Id the SIP Call-Id
Join Id the internal join id of the (explicit or implicit) join that initiated this media line. This has the special value of "brdgsrv" for the media line joining an endpoint with it's bridging server. Both the endpoint and the primary call leg should use this value. The secondary call leg's media lines should use the join ids for the CCXML joins invoked on the endpoint.
Type the media type (e.g. audio, video)
IP the IP address of the media line (offered by the endpoint)
Port the port of the media line (offered by the endpoint)
Directionality the directionality (offered by the endpoint);
none
Codecs the list of codecs (offered by the endpoint)

Metrics Id: 1047

merge

Merge

Logged whenever the <merge> tag is executed.

Format

merge <Connection Id 1>|<Connection Id 2>
Connection Id 1 the first connection id
Connection Id 2 the second connection id

Metrics Id: 1048

move

Move

Logged whenever the <move> tag is executed.

Format

move <Move Type>|<Id>|<Target Id>
Move Type an indicator of whether an event or source was moved; indicated by: an event was moved an event source was moved
event an event was moved
source an event source was moved
Id the event id or source id
Target Id the target session id

Metrics Id: 1049

new_session

New Session

Logged whenever a new CCXML session is initiated.

Format

new_session <CCXML URI>|<Session Start Mode>|<Origin>
CCXML URI the initial URI of the CCXML application
Session Start Mode the mechanism used to start the session; one of:
newcall
external
createccxml
Origin For calls started by a connection, the connection id of the initiating call. For externally created calls, the eventsource URI. For forked sessions, the session id of the parent session.

Metrics Id: 1050

page_data

Page Data

Logged immediately after page_start that contains the query string information of the page. This is only logged if there is a query string in the page URI.

Format

page_data <URI>|<Post Parameters>
URI the URI of the CCXML page. The query string is present, however, the fragment info, (e.g. "#" and everything after) should be omitted
Post Parameters the request parameters for a POST; "N/A" for a GET

Metrics Id: 1051

page_start

Page start

Logged whenever a page has been compiled and its execution is beginning.

Format

page_start <URI>
URI the URI of the CCXML page; the query string (everything after "?") and the fragment info ("#" and everything after) should be omitted

Metrics Id: 1052

redirect

Redirect

Logged whenever the <redirect> tag is executed.

Format

redirect <Connection Id>|<Destination>|<Reason>
Connection Id the connection id
Destination the destination URI
Reason the reason text

Metrics Id: 1053

reject

Reject

Logged whenever the <reject> tag is executed.

Format

reject <Connection Id>|<Reason>
Connection Id the connection id
Reason the reason text

Metrics Id: 1054

script

Script

Logged whenever the <script> tag is executed (i.e. the contained script is executed).

Format

script <Script Type>|<Source>
Script Type An indication of whether this was a referenced (by URI) script or a fetched (using a fetchid) script or an inline script. This is denoted by: a referenced script a fetched script an inline script
refer a referenced script
fetch a fetched script
inline an inline script
Source the URI for referenced scripts, the fetch id for fetched scripts, or the script if this is an inline script (If truncated, then "..." should be appended to it.)

Metrics Id: 1055

send

Send

Logged whenever the <send> tag is executed.

Format

send <Send Id>|<Target Type>|<Target Id>|<Event Name>|<Delay>
Send Id the send id
Target Type the target type
Target Id the target id
Event Name the event name (i.e. the data value)
Delay the delay value ("0" if not specified)

Metrics Id: 1056

send_data

Send Data

Logged whenever the <send> tag is executed. This contains the namelist data and is logged immediately after the send metric.

Format

send_data <Send Id>|<Namelist>
Send Id the send id
Namelist the namelist parameters as a name-value pair list.

Metrics Id: 1057

session_reject

Session Reject

Logged whenever an HTTP request to create a new session is rejected.

Format

session_reject <Reject Reason>
Reject Reason a reason code; as defined by conn_reject

Metrics Id: 1058

session_req

Session Request

Logged whenever an HTTP request to create a new session is received.

Format

session_req <Post Body>
Post Body the body of the HTTP POST request

Metrics Id: 1059

transition_begin

Transition Begin

Logged whenever a transition handler begins executing.

Format

transition_begin <Event Id>|<Event Name>|<Condition>
Event Id the event id
Event Name the event name
Condition the condition

Metrics Id: 1060

transition_end

Transition End

Logged whenever a transition handler completes executing.

Format

transition_end

Metrics Id: 1061

unjoin

Unjoin

Logged whenever the <unjoin> tag is executed.

Format

unjoin <Endpoint Id 1>|<Endpoint Id 2>|<Join Id>
Endpoint Id 1 the first id
Endpoint Id 2 the second id
Join Id the internal join id that identifies the unjoin

Metrics Id: 1062

var

var

Logged whenever a <var> tag is executed.

Format

var <Name>|<Value>
Name the name of the variable assigned
Value the initial value assigned to the variable

Metrics Id: 1063