ESChat and CNS diagnostics logging
For the information displayed in the diagnostics item logs can be generated to track the individual events. This is useful to inspect concerns, such as an MCR Create event taking 30 seconds.
All events are cached in memory as they are received. Then every few seconds flushed out to the log files. This results in a short delay in what you may see in the diagnostics page and when those details show up in the diagnostics logs.
The following table describes the XML tags used to enable logging.
Diagnostics logging parameters
XML tag | Description |
|---|---|
<diagnosticslog_location> | (Required) Specifies a directory for the log files. Several log files will be generated. Main.log will be the merged list of all items being tracked in the order in which they were received. In addition to the main.log file, a log file is generated for each event. If the path specified does not exist, then the CNS and ESChat modules attempt to create the path specified. Note: If a valid path is not set, diagnostics logging does not work. Example: <diagnosticslog_location>c:\myes_conf\eschat_diagnosticslogs</diagnosticslog_location> |
<diagnosticslog_include> | (Optional) A comma-separated list of diagnostic items to include in the logging. An included value overrides the exclude option. Any XML tag item under the <status> tag can be specified to include. The values must match the names of the items from the <diagnosticsitems> section for the specific module. For more information, see ESChat-and-CNS-diagnostic-information. If no settings are specified, then all items are logged. The include and exclude options can contain the * wildcard parameter. Since the SupportBot pings also include a module specific ID which dynamic, a wildcard allows for the logging of the pings without having to specify their particular ID. Example: <diagnosticslog_include>AIML,Supportbot Ping*</diagnosticslog_include> |
<diagnosticslog_exclude> | (Optional) A comma-separated list of diagnostic items to exclude in the logging. Any XML tag item under the <status> tag can be specified to include. The values must match the names of the items from the <diagnosticsitems> section for the specific module. For more information, see ESChat-and-CNS-diagnostic-information. If no settings are specified, then all items are logged. The include and exclude options can contain the * wildcard parameter. Since the SupportBot pings also include a module specific ID which dynamic, a wildcard allows for the logging of the pings without having to specify their particular ID. Example: <diagnosticslog_exclude>Supportbot Ping*,CNS Check</diagnosticslog_exclude> |
To enable ESChat diagnostic logging:
- In the Virtual Chat Administration Console, select Self Service Portal > Configuration.
Select System Configuration, and click Modify.
After the <debugsessionlogs></debugsessionlogs> tags, paste the following XML structure on a new line.
<diagnosticslogging>
<diagnosticslog_location>c:\myes_conf\eschat_diagnosticslogs</diagnosticslog_location>
<diagnosticslog_exclude>Supportbot Ping*,CNS Check</diagnosticslog_exclude>
<diagnosticslog_include>AIML,Supportbot Ping*</diagnosticslog_include>
</diagnosticslogging>- Modify the parameters as described in the Diagnostic logging parameters table.
- Click Save.
- In the Self Service Portal Configuration screen, click Apply.
- In the Registered Servlets table, select the ESChat servlet, and click Refresh Servlets.
To enable CNS diagnostic logging:
- Open in the cns_config.properties file in a text editor.
Add the following XML structure:
<diagnosticslogging>
<diagnosticslog_location>c:\myes_conf\cns_diagnosticslogs</diagnosticslog_location>
<diagnosticslog_exclude>Supportbot Ping*,logins</diagnosticslog_exclude>
<diagnosticslog_include>AIML,Supportbot Ping*</diagnosticslog_include>
</diagnosticslogging>- Modify the parameters as described in the Diagnostic logging parameters table.
- Save the file.
- In the Virtual Chat Administration Console, select Self Service Portal > Configuration.
- In the Registered Servlets table, select the CNS servlet, and click Refresh Servlets.
Related topics