Setting Log Levels

The second step of the Logging Configuration Wizard enables adjusting the log levels.

All logging modules have the LogLevel setting. In addition to that, some modules have level settings for submodules, or other additional settings, and optional advanced settings.

Table 1. Logging Settings

Logging Module

Setting

Description

All logging modules

LogLevel

Select logging level for the logging module. For values, see the table below.

Agent Server

TerminalServer.Level

Select logging level for the TerminalServer submodule. Added to Agent Server in 1608.

Agent Server WebClient, WebClient

WebClient.Level

Select logging level for the WebClient submodule.

Alarm Server

AlarmServer.Level

Select logging level for the AlarmServer submodule.

Batch Job Server

ImportExport.Level

Select logging level for import and export jobs, written in a separate file.

Call Dispatcher

CallDispatcher.Level

Select logging level for the CallDispatcher submodule.

CEM Server, Interface OII, Chat Portal, Chat Server, Terminal Server (until 1608)

Hide Sensitive Information (DebugSecure)

This setting is on by default. In many troubleshooting scenarios, it is necessary to turn it off to reveal details of the contact flow.

As of 1608, Terminal Server is included in Agent Server, and no sensitive data is printed in logs.

CEM Server

Debug

Enter a number from 1 to 9 to set the level of the CEM-specific debugging. In most troubleshooting scenarios the value has to be set to 7-9.

Cem.Level

Select logging level for the CEM submodule.

Directory Server

DirectoryServer.Level

Select logging level for the DirectoryServer submodule.

External Terminal Controller

Etc.Level

Select logging level for the Etc submodule.

H323 Bridge

H323Bridge.Level

Select logging level for the H323Bridge submodule.

SIP Bridge

Trace B-Numbers (TracedInboundBNumbers)

To start tracing of certain B numbers, enter a comma-separated list of B numbers. The most detailed (debug) trace is saved and the text TraceMessageId and the trace id is added to the logs of all calls made to this number. The setting is removed from SIP Bridge installation variables in SP07.

To stop tracing, select (no value).

Terminal Server (Merged to Agent Server in 1608)

TerminalServer.Level

Select logging level for the TerminalServer submodule. Added in SP08.

Logging Levels

To set the level of information included in log files, select the value from the following options.

Table 2. Level Values

Value

Description

inherited

For submodules only, follows the module’s loglevel setting.

never

Prevents logging, even printing the log file.

Note:

Use only in special occasions, prevents collecting information that may be crucial for troubleshooting.

always

Messages that should always be printed, such as process startup notifications.

error

Messages about operation failures. Part of the module functionality is likely not working correctly for example due to malfunctioning hardware, misconfiguration or unexpected scenarios.

warning

Warning messages indicate of problems that are somehow recoverable or are in less important functions. For example, minor misconfigurations, performance warnings, temporary unavailability of a service.

info

Informative messages about business-level or service-level objects.

trace

Messages to trace module execution in more detail. Typically contains useful information for developers only, providing information about execution of the code.

debug

Most detailed messages about module execution. Typically contains useful information for developers only, often used for tracing some specific or unexpected scenarios.

Note:

Use temporarily only. Continuous use causes load to servers and may impair performance.

Keep Current Value

The value selected by default, leaves the value unmodified.

Note:

Exception: File Replication Server (WFRS) uses levels different from other modules:

  • 0 = ERROR

  • 1 = INFO

  • 2 = DEBUG

  • 3 = TRACE

  • 4 = ALWAYS

Advanced Settings

To configure advanced settings as well, click the Filter icon, and choose Show Advanced Logging Settings. Most of the advanced settings are common to most modules, as some settings are specific to one module only.

Table 3. Advanced Logging Settings

Advanced Logging Setting

Description

Available in Logging Modules

BcmApi.Level

Select logging level of events related to API library of Sinch Contact Pro.

Agent Server, Agent Server WebClient, Batch Job Server, Batch Job Server Local BCM API ,Call Dispatcher, Chat Server, CEM Server,Directory Server, E-Mail Sender External Terminal Controller , interfaces ACI, DAI, PSI, RDI, TMI, Terminal Server (until 1608), Web Client

CommonLib.Level

Select logging level of events related to common library code.

Agent Server, Agent Server WebClient, Alarm Server,Batch Job Server, Batch Job Server Local BCM API, Call Dispatcher, Chat Peer, Chat Server, CEM Server,Data Collector, Directory Server, ECF Front End Server, External Terminal Controller, E-Mail Sender, H3232 Bridge, HAC, HAC Deployment, interfaces ACI, DAI, PSI, RDI, TMIOII Peer, Media Routing Server (MRS), Quality Monitoring Server (QMS), SMS Server, Terminal Server (until 1608), Web Client

Database.Level

Select logging level of database access related events.

Agent Server, Agent Server WebClient, Alarm Server,Batch Job Server, Batch Job Server Local BCM API , Call Dispatcher, Chat Server, CEM Server,Data Collector, Directory Server, External Terminal Controller, E-Mail Sender, interfaces ACI, DAI, PSI, RDI, TMI, SMS Server, Terminal Server, Web Client

EventCollection.Level

Added in 1705

Select logging level of events related to Event Collection API (Data Collector events)

Agent Server, Chat Server, CEM Server

LibIpc.Level

Select logging level of events related to Inter Process Communications library.

Agent Server, Agent Server WebClient, Alarm Server,Batch Job Server, Batch Job Server Local BCM API, Call Dispatcher, Chat Peer, Chat Server, CEM Server,Data Collector, Directory Server, ECF Front End Server, External Terminal Controller, E-Mail Sender, H3232 Bridge, HAC, HAC Deployment, interfaces ACI, DAI, PSI, RDI, TMIOII Peer, Media Routing Server (MRS), Quality Monitoring Server (QMS), SMS Server, Terminal Server (until 1608), Web Client

LibIpcThreading.Level

Sub-location for LibIpc logging location. The location prints fine details of internal thread and concurrency related traces of the modules LibIpc networking library.

Chat Peer, OII Peer

Network.Level

Select logging level of network related events

Agent Server, Agent Server WebClient, Alarm Server,Batch Job Server, Batch Job Server Local BCM API, Call Dispatcher, Chat Peer, Chat Server, CEM Server,Data Collector, Directory Server, ECF Front End Server, External Terminal Controller, E-Mail Sender, H3232 Bridge, HAC, HAC Deployment, interfaces ACI, DAI, PSI, RDI, TMIOII Peer, Media Routing Server (MRS), Quality Monitoring Server (QMS), SMS Server, Terminal Server, Web Client

ObjectManagement.Level

Category of events modifying business level objects.

Agent Server, Agent Server WebClient, Batch Job Server, Batch Job Server Local BCM API , Call Dispatcher, Chat Server, CEM Server, External Terminal Controller, E-Mail Sender, interfaces ACI, DAI, PSI, RDI, TMI, Terminal Server, Web Client

Security.Level

Select logging level of security related events

Agent Server, Agent Server WebClient, Alarm Server,Batch Job Server, Batch Job Server Local BCM API, Call Dispatcher, Chat Peer, Chat Server, CEM Server,Data Collector, Directory Server, ECF Front End Server, External Terminal Controller, E-Mail Sender, H3232 Bridge, HAC, HAC Deployment, interfaces ACI, DAI, PSI, RDI, TMIOII Peer, Media Routing Server (MRS), Quality Monitoring Server (QMS), SMS Server, Terminal Server (until 1608), Web Client

DebugIMAP

Select if log entries related to sending and receiving e-mails are printed.

CEM Server

DebugScheduler

Select if log entries related to scheduling are printed.

CEM Server

ODBCDebug

Select if log entries about database transactions are printed.

CEM Server

PRSDebug 

Select if log entries related to presence profiles are printed.

CEM Server

Pdc.Level

Select logging level for the submodule responsible of the Outbound campaigns.

CEM Server

PythonWrapper.Level

Select logging level for the submodule responsible of TCP/IP communication with other modules and database transactions.

CEM Server

EventCollection.Level

Select logging level in webclient sending events to Data Collector over the network.

Agent Server WebClient

LR.Level

Select logging level of events related to License Reporting, written in a specific file.

Batch Job Server

HACSystemManager.Level

Select logging level of events related to HAC’s internal system model management mechanism.

HAC