Log4j Logs and Traces in Verastream Host Integrator

  • 7021322
  • 05-Jun-2013
  • 11-Mar-2018

Environment

Verastream Host Integrator version 7.0 or higher

Situation

Beginning in version 7.0, a number of Verastream Host Integrator (VHI) components use the log4j utility for logging and tracing. This technical note describes the configuration steps and output file locations.

Resolution

Log4j Output Files

By default, the log4j output files typically contain errors only. The log4j output files can be found in the following locations:

Component
Log4j Default Output
Administrative Console
To view the output within Administrative Console, click View > Other Views > General > Console > OK.
If there is an error, the output file is written to:
On Windows 7, Windows Server 2008, or Windows Vista:
C:\Users\<user name>\.attachmate\verastream\adminconsole\.metadata\.log
On Windows XP:
C:\Documents and Settings\<user name>\.attachmate\verastream\adminconsole\.metadata\.log
Design Tool
C:\Program Files\Attachmate\Verastream\HostIntegrator\destool\logs\server.log
Session Server
%VHI_ROOT%/sesssrvr/logs/server.log
Management Server
Windows: C:\Program Files\Attachmate\Verastream\ManagementServer\logs\server.log
Linux/UNIX: /opt/attachmate/verastream/managementserver/logs/server.log
Web Services SOAP stack
(Version 7.5.1030 or higher) %VHI_ROOT%/sesssrvr/logs/soap-server.log

Configuring Log4j Trace

To enable trace-level logging, complete the following steps.

Note: Tracing is recommended for temporary use only; since there is no output size limit, ongoing activity may cause the output file to consume all available disk space.

  1. Edit the appropriate .xml configuration file for your component. (If the file does not existing in your Linux/UNIX installation, copy it from a Windows installation.)
    Component
    Log4j XML Configuration File
    Administrative Console
    C:\Program Files\Attachmate\Verastream\AdministrativeConsole\configuration\log4j.xml
    Design Tool
    C:\Program Files\Attachmate\Verastream\HostIntegrator\destool\conf\log4j.xml (except %VHI_ROOT%\bin\log4j.xml for version 7.1.1142 only)
    Session Server
    %VHI_ROOT%/sesssrvr/conf/log4j.xml (except %VHI_ROOT%\bin\log4j.xml for version 7.1.1142 only)
    Management Server
    Windows: C:\Program Files\Attachmate\Verastream\ManagementServer\conf\log4j.xml
    Linux/UNIX: /opt/attachmate/verastream/managementserver/conf/log4j.xml
    Note: There are additional separate configuration files for specific functions (peer replication, directory servers, authorization, session pool schedules, etc.). For example, for authentication and authorization issues, modify the file managementserver/services/directory/META-INF/log4j-directory.xml.
    Web Services SOAP stack
    (Version 7.5.1030 or higher) %VHI_ROOT%/sesssrvr/services/ws/META-INF/log4j-ws.xml

Note: In the future, when you upgrade to a later version (hotfix, service pack, or major release), the .xml file may revert to its original defaults.

  1. Determine which logger node(s) are appropriate to change, based on the configuration file comments or suggestions by Technical Support. Change the log level to trace for the most detailed information:
<level value="trace"/>

Also, if there are any comment characters surrounding the logger node (<!-- before <logger>, and --> after </logger>), delete these characters.

  1. After saving the revised .xml file, the change typically takes effect automatically within minutes. You may need to manually restart a service for the change to take effect immediately (see KB 7021352).

Note: In the future, when you upgrade to a later version (hotfix, service pack, or major release), the log4j.xml file may revert to its original defaults.

  1. Reproduce the issue.
  2. View the log4j output. See Log4j Output Files above.
  3. Restore the original log level (typically error or info). Note: Tracing is recommended for temporary use only; since there is no output size limit, ongoing activity may cause the output file to consume all available disk space.

Additional Information

Legacy KB ID

This document was originally published as Attachmate Technical Note 10149.