Cisco Cisco Unified Customer Voice Portal 10.5(1) User Guide
C
HAPTER
5:
V
OICE
XML
S
ERVER
L
OGGING
V
OICE
XML
S
ERVER
U
SER
G
UIDE
FOR
C
ISCO
U
NIFIED
C
USTOMER
V
OICE
P
ORTAL
R
ELEASE
4.0(1)
77
Figure 5-2
Figure 5-2 displays the format for the XML Error Logger configuration file. The main tag for the
configuration,
configuration,
configuration
, has two attributes,
name
and
version
. Name is expected to
contain the logger instance name. The version is expected to include the version of the
configuration, which is currently “1.0”. The subsequent sections describe the functionality of the
various tags in the configuration.
configuration, which is currently “1.0”. The subsequent sections describe the functionality of the
various tags in the configuration.
Error Logger Configuration: Format
The
<format>
tag allows for the modification of how the error log files are formatted. All Error
Logger configurations are required to define a format. The possible attributes are:
delimiter
. This required attribute defines the delimiter to use to separate columns on a line.
Delimiters can be any string value, though typically will be a comma or tab. To use a special
white space character such as a new line or tab, use the escaped version. The possible values
are “\n” (denoting a new line), “\t” (denoting a tab), “\r” (denoting a return), and “\f”
(denoting a line feed).
white space character such as a new line or tab, use the escaped version. The possible values
are “\n” (denoting a new line), “\t” (denoting a tab), “\r” (denoting a return), and “\f”
(denoting a line feed).
remove_delimiter_from_content
. When this required attribute is set to
true
, the Error Logger
will attempt to eliminate the delimiter from any content appearing in the logs to ensure that
the log file can be imported flawlessly. For example, if the delimiter is a comma and the
configuration is set to remove the delimiter, when it is to log the content “This, is the
description”, it will appear in the log as “This is the description” so as not to affect the
accuracy of the importing process. This extra step, though, does incur a slight performance
hit. This step will not be performed if this attribute is set to
the log file can be imported flawlessly. For example, if the delimiter is a comma and the
configuration is set to remove the delimiter, when it is to log the content “This, is the
description”, it will appear in the log as “This is the description” so as not to affect the
accuracy of the importing process. This extra step, though, does incur a slight performance
hit. This step will not be performed if this attribute is set to
false
. Note that should the error
log contain Java stack traces, the error logs could be difficult to import as stack traces fill
multiple lines (though their content will be cleaned of the delimiter if desired).
multiple lines (though their content will be cleaned of the delimiter if desired).
date_format and date_granularity
. These required attributes set how the second column of the
error log references a date when the event occurred. The format and granularity are specified.
There are three possible values for the
There are three possible values for the
date_format
attribute:
o
standard
. This is a standard readable date format in the form “MM/DD/YYYY
HH:MM[:SS][.MMM]” where the hour is in 24-hour time and the last three digits are the
milliseconds. The seconds and milliseconds are displayed with brackets to indicate that
their appearance are based on the
milliseconds. The seconds and milliseconds are displayed with brackets to indicate that
their appearance are based on the
date_granularity
attribute. For a
date_granularity
attribute set to
minutes
, just the hours and minutes of the time will be displayed. For a