Setting up gateway logging

The Video Gateway system log records information about events and alarms. The name format for the log is:

callserver_creationdate_[index].log

where:

To view log files, use the Log files option on the Monitoring menu. For more information, see Log files.

This topic describes:

Logging levels

The following table describes the logging levels in decreasing severity and increasing verbosity order:

Logging level

Description

FATAL

Logs only critical errors.

ERROR

Logs all errors.

WARNING

Logs all errors and warnings.

INFO1

Logs information useful for first-level debugging and also logs some normal events.

INFO2

INFO3

Logs information useful for second-level debugging.

Because this level generates abundant log information, you should set this level only at the request of gateway support personnel.

INFO4

INFO5

The most verbose option, which logs low-level detailed information.

Because this level generates abundant log information, you should set this level only at the request of gateway support personnel.

Logging defaults

The gateway system logging defaults are:

Changing the logging level

To change the gateway logging level, follow these steps:

Step

Action

1

Access the Vision Console, as described in Accessing the Vision Console.

2

Click Maintenance on the Operations menu.

The Maintenance page appears.

3

To change the log level, select the desired log level in the Log level field, and click Submit.

Changing other logging defaults

The following table describes how to change the other logging defaults:

To change the...

Modify the...

Log file location

LogDir setting in the callserver.conf file.

Maximum number of log files in the specified directory

SystemLogFileMaxNum setting in the callserver.conf file.

Maximum size of the log file

SystemLogFileMaxSize setting in the callserver.conf file.

For more information about the callserver.conf file, see the Dialogic® Vision™ Call Server Administration Manual.

Log file format

The format of each log message is:

timestamp  [severity]  [origin:code]  [UID:threadID]  (alarm)  [message]

where timestamp is formatted in local server time by default.

For example, a telecom configuration error might lead to the following log file entry:

03/29/05 06:59:25.306 [ERROR] [telecom.pkg:111] [-:1044] (ConfigurationError) -
A trunk is declared with an unavailable protocol, line 16.

Use the SystemLogTime setting in the callserver.conf file to change the time format to Greenwich Mean Time (GMT). This also changes the time format in the log file name. For information, see the Dialogic® Vision™ Call Server Administration Manual.

The following table describes gateway log file fields:

Field

Description

severity

Level of the log message.

Valid values in order of decreasing severity and increasing verbosity:

  • FATAL (a severe malfunction from which the gateway processor cannot recover)

  • ERROR

  • WARNING

  • INFO1

  • INFO2

  • INFO3

  • INFO4

  • INFO5 (highest/most verbose level of detail)

origin

Gateway component to which the log message refers.

code

Trace identifier of the message in the gateway component to which the log message refers.

UID

Reserved for future use. The UID is represented by a hyphen (-) in the log file.

threadID

Identifier associated with the thread that generated the message. Use this field to track the progress of a single session or call when several requests are being processed simultaneously.

alarm

Optional field that is included only when the log message refers to an alarm notification. In this situation, the field describes the general category of the alarm.

Alarm categories include:

  • Started

  • Quiesced

  • Shutdown

  • LicenseCheck

  • ConfigurationError

  • InitializationError

  • SoftwareException

  • InternalError

  • ResourceLimitation

  • CommunicationFailure

  • ProcessingFailure

  • InvalidArgument

  • UnexpectedEvent

  • NotificationDiscarded

  • Watchdog

  • Timeout

message

Text description of the logged occurrence.