Debug Logging

To help you determine the cause of an error, you can turn on debug logging so that AcuXDBC traces AcuXDBC and COBOL file activities, and writes them to a file.

This logging can be configured so that it is enabled every time you use a particular data source, or for certain connection types, you can enable it dynamically on a connection-by-connection basis.

The easiest way to permanently enable logging for a data source is by using the Logging tab, available when you set up a connection in the ODBC Data Source Administrator. See AcuXDBC Setup: Logging Tab for more information.

To use configuration variables to enable debug logging, set the DEBUG_LOGFILE and DEBUG_LOGLEVEL configuration variables.

For JDBC connections, you can either enable debug logging dynamically, so that it is enabled just for that particular connection, or you can use a configuration file (called vortex.properties), which will be used if placed in the same directory as vortex.jar.

To enable dynamically, append the required GENESIS variables to your connection string; for example, the following string sets full logging:

jdbc://uid/pwd/xvision:acuxdbc.cfg@20222:machinename!acuxdbc04,GENESIS_LOGFILE=/path/to/logfile.log,GENESIS_LOGOPTS=3

Again for JDBC connections, if you place a configuration file (called vortex.properties) in the same directory as vortex.jar, its configuration is used for debug logging. The following sample shows the options available within the configuration file:

# VORTEXJava logging
# logfile is the name of the logfile, e.g. /tmp/logfile
# logfile=/tmp/logfile
# logopts is a list of options, separated by + (optional)
# logopts=FULL+MULTI+TIME
#
# VORTEXjdbc connection commands:
# These are sent to the target after the connection succeeds.
# A maximum of 20 statements are sent and they must be consecutively numbered
# without gaps.
#
# jdbcsql0=set option logfile '/tmp/test_c3po.log'
# jdbcsql1=set option plan on
#
# VORTEX network parameters
# connect_timeout - seconds to wait on a connect
# connect_timeout=15
# read_timeout - seconds to wait on a read response
# read_timeout=1440
# key_connect - integer key to use for uid/pwd obfuscation. Must match the
#               -kn vtxnetd option value.
# key_connect=1999
# environment_variables=VORTEX_HOST_LOGFILE=/tmp/test,VORTEX_HOST_LOGOPTS=FULL

Uncomment (and edit, where required) the options in the configuration file; for example, to enable full logging:

logfile=/tmp/logfile
logopts=FULL

The valid logopts keywords are:

FULL
Verbose output
MULTI
Append a time-stamp to the logfile name
TIME
Inserts time-stamps in the logfile.

You can specify more than one option, separated by +; the order in which you specify each option is not important.

The VORTEXjdbc commands are typically 'set option' commands; no query statements are allowed here. The statements are sent immediately after the connection is made.

The environment_variables value is appended to the connection string to make it easier to manage server-side logging.