Logging

This article talks about the log files available in Recital products and how to enable logging when required.

Yvonne Milne
February, 2007.

Overview

When discussing a problem with the Recital Support Team, one of the most common requests is that you enable logging and send them the log files produced. Log files along with error files are designed to provide detailed information about Recital processes and the prevailing environment and can be a fast-track to resolving a problem.

Log Files

There are three main types of log file:

1. System Log
2. Client/Server Communication Logs
3. Custom Logs

System Log

The System log is a system-wide per-product log. It tracks all login and logout operations from either Recital Terminal Developer or the Recital Universal Application Server (Recital Database Server, Mirage Application Server or Web Developer Firecat Server). Logout details include the exit code: 0 for an error-free, 'normal' exit and the error number and message when an error has occurred. It also shows the licenses that have been loaded and any license error codes and messages. The system log filename is recital.log.

Client/Server Communication Logs

The Client/Server communication logs track the requests and responses between the Recital Universal Application Server and its clients. The log files are as follows:

Custom Logs

The Recital/4GL USERLOG() function can be used to log information to a user-specific log file for debugging or audit trail purposes. For full information on this function, please see the USERLOG() documentation.

Enabling Log Files

For instructions on enabling log files for individual products, please follow these links:

NOTE: Remember the Recital Universal Application Server controls the Recital Database Server, the Recital Mirage Application Server and the Recital Web Developer Firecat Server.

• Recital Universal Application Server for Windows
• Recital Universal Application Server for Linux
• Recital Universal Application Server for UNIX
• Recital Universal Application Server for OpenVMS
• Recital Terminal Developer for Windows
• Recital Terminal Developer for Linux
• Recital Terminal Developer for UNIX
• Recital Terminal Developer for OpenVMS

Enabling Log Files: Recital Universal Application Server for Windows

To enable the system log file for the Recital Universal Application Server for Windows, include the following command in the UAS\config.db file:

set syslogging on

The Recital Server Manager System Logging tab allows for the viewing and resetting of the System log.

To set up Client/Server logging, use the Recital Server Manager Settings tab to update the server's Registry entries:

The following Log file settings can be configured:

Enabling Log Files: Recital Universal Application Server for Linux

To enable the system log file for the Recital Universal Application Server for Linux, include the following command in the UAS/config.db file:

set syslogging on

To set up Client/Server logging, the Recital Universal Application Server can be started with the 'logging' parameter, in which case, all relevant logging will take place.

# uas startup logging

Alternatively, one or more of the following environment variables can be added to the profile.uas file or set at the Operating System prompt.  The Recital Universal Application Server must be restarted before environment variable changes will be recognized.  Each environment variable should be set to the name of a log file.

Extract from profile.uas:

UASLOG_PORT="port.log" ; export UASLOG_PORT
UASLOG_NET="net.log"   ; export UASLOG_NET
UASLOG_ORA="ora.log"   ; export UASLOG_ORA
UASLOG_INF="inf.log"   ; export UASLOG_INF
UASLOG_ING="ing.log"   ; export UASLOG_ING
UASLOG_JDB="jdb.log"   ; export UASLOG_JDB
UASLOG_REC="rec.log"   ; export UASLOG_REC

DB_LOGDIR

If the environment variable DB_LOGDIR is set to an existing directory, all log files will be written to this directory.  If not, the log files will be created in the UAS directory.

DB_LOGDIR is set in the UAS/profile.uas file. By default it is set to the UAS/log directory:

DB_LOGDIR=${DB_ROOT}log/           ; export DB_LOGDIR

DB_LOGVER

If the environment variable DB_LOGVER is enabled, version numbers are added to the file names.  For example, the activity of the first Net Server process will be logged to net.log, the second to net001.log, the third to net002.log etc.

DB_LOGVER is set in the UAS/profile.uas file:

DB_LOGVER="yes"                    ; export DB_LOGVER

Enabling Log Files: Recital Universal Application Server for UNIX

To enable the system log file for the Recital Universal Application Server for UNIX, include the following command in the UAS/config.db file:

set syslogging on

To set up Client/Server logging, the Recital Universal Application Server can be started with the 'logging' parameter, in which case, all relevant logging will take place.

# uas startup logging

Alternatively, one or more of the following environment variables can be added to the profile.uas file or set at the Operating System prompt.  The Recital Universal Application Server must be restarted before environment variable changes will be recognized.  Each environment variable should be set to the name of a log file.

Extract from profile.uas:

UASLOG_PORT="port.log" ; export UASLOG_PORT
UASLOG_NET="net.log"   ; export UASLOG_NET
UASLOG_ORA="ora.log"   ; export UASLOG_ORA
UASLOG_INF="inf.log"   ; export UASLOG_INF
UASLOG_ING="ing.log"   ; export UASLOG_ING
UASLOG_JDB="jdb.log"   ; export UASLOG_JDB
UASLOG_REC="rec.log"   ; export UASLOG_REC

DB_LOGDIR

If the environment variable DB_LOGDIR is set to an existing directory, all log files will be written to this directory.  If not, the log files will be created in the UAS directory.

DB_LOGDIR is set in the UAS/profile.uas file. By default it is set to the UAS/log directory:

DB_LOGDIR=${DB_ROOT}log/           ; export DB_LOGDIR

DB_LOGVER

If the environment variable DB_LOGVER is enabled, version numbers are added to the file names.  For example, the activity of the first Net Server process will be logged to net.log, the second to net001.log, the third to net002.log etc.

DB_LOGVER is set in the UAS/profile.uas file:

DB_LOGVER="yes"                    ; export DB_LOGVER

Enabling Log Files: Recital Universal Application Server for OpenVMS

To enable the system log file for the Recital Universal Application Server for OpenVMS, include the following command in the db_uas:config.db file:

set syslogging on

To set up Client/Server logging, one or more of the following symbols can be added to the db_uas:login.com file.  The Recital Universal Application Server must be restarted before symbol changes will be recognized.  Each symbol should be set to the name of a log file.

Extract from db_uas:login.com

$ uaslog_port :==  port.log
$ uaslog_net  :==  net.log
$ uaslog_ora  :==  ora.log
$ uaslog_inf  :==  inf.log
$ uaslog_ing  :==  ing.log
$ uaslog_jdb  :==  jdb.log
$ uaslog_rec  :==  rec.log

DB_LOGDIR

If the symbol DB_LOGDIR is set to an existing directory, all log files will be written to this directory.  If not, the log files will be created in the UAS directory.

DB_LOGDIR is set in the db_uas:login.com file. By default it is set to the UAS.log] directory:

$db_logdir    :== 'db_root'.log]               ! system logging directory

DB_LOGVER

If the symbol DB_LOGVER is enabled, version numbers are added to the file names. For example, the activity of the first Net Server process will be logged to net.log, the second to net001.log, the third to net002.log etc.

DB_LOGVER is set in the db_uas:login.com file:

$db_logver  :== true                           ! enable multiple log files

Enabling Log Files: Recital Terminal Developer for Windows

To enable the system log file for Recital Terminal Developer for Windows, include the following command in the UD/config.db file:

set syslogging on

Enabling Log Files: Recital Terminal Developer for Linux

To enable the system log file for Recital Terminal Developer for Linux, include the following command in the UD/config.db file:

set syslogging on

Enabling Log Files: Recital Terminal Developer for UNIX

To enable the system log file for Recital Terminal Developer for UNIX, include the following command in the UD/config.db file:

set syslogging on

Enabling Log Files: Recital Terminal Developer for OpenVMS

To enable the system log file for Recital Terminal Developer for OpenVMS, include the following command in the db_ovd:config.db file:

set syslogging on

In Brief

• Log files provide important information to aid problem resolution, but they are also an overhead, so logging should only be enabled when required, not in normal production operation.
• The System log provides a system-wide view of logins, exits and error codes.
• The System log is enabled using the SET SYSLOGGING ON Recital/4GL command in the system config.db file.
• Client/Server logs provide detailed information on client/server requests and responses.
• Client/Server logs are enabled using environment variables, symbols or Registry entries or by specifying the 'logging' parameter when starting the Recital Universal Application Server.
• The location of log files is determined by the DB_LOGDIR setting.
• Versioning of log files is determined by the DB_LOGVER setting.