Environment
Situation
This technical note discusses how to configure and use Verastream Host Integrator (VHI) logging for the session server component.
Resolution
About VHI Logging
VHI logging is useful for temporarily troubleshooting or gathering usage statistics if the alternative recommended options are not available or applicable:
- For troubleshooting host application or modeling issues, model debug messages is recommended. See KB 7021543.
- For gathering VHI server usage statistics, the “high water mark” message or SNMP (Simple Network Management Protocol) is recommended. For more information on “high water mark” tracking, see KB 7021568.
Configuring the session server to log all messages can have a high impact on server performance. Thus, the above alternatives are recommended when practical.
Enabling VHI Logging
Follow the steps below to set up session server logging.
- Run the Administrative Console application from the Start menu shortcut. Note: UNIX/Linux servers are administered from a Windows system. Administrative Console is available on Windows only.
- Log in using an administrator profile. For more information about authentication credentials, see KB 7021567.
- In the left tree pane, right click on the session server for which you want to configure logging and click Properties.
- In the Session Server Properties dialog, in the left pane, click Logging.
- From the Default Log Level list, specify which event messages to add to log files. Log Errors is the default. Log All Messages will record all informational messages, warnings, and errors.
Note: Log All Messages has an impact on server performance. You may want to select a reduced logging level for improved performance on heavily loaded servers.
- In the Log Storage Directory field, you can modify the location where the log file should be saved. By default, this is a subdirectory in your VHI installation directory.
- Enable System Logging if you also want the messages to be sent to the operating system log (Windows event log, or UNIX/Linux syslog daemon; see also Operating System Logs section below).
- Enable Failed Request Information Logging to capture informational messages preceding an error even when not using Log All Messages.
- Click OK.
Note: The VHI Log Manager service must be installed and running on the same system(s) as the session server. (In a session server load distribution configuration, Log Manager runs on each system.) For information on starting VHI services, see KB 7021352.
After you have captured the desired problem or traffic, repeat the steps above to reset the Default Log Level to its original value.
Redacting of Sensitive Data
Beginning in version 7.5 SP1, certain sensitive data such as host passwords are no longer visible in session server log messages. The following data is removed:
- Values of model variables that have Encrypt enabled. This configuration is typically used for host passwords in model variable lists.
- Encrypted values set in model operation commands, such as TransmitToAttrEncrypted and TransmitANSIEncrypted.
- Values written to non-displayed terminal fields (3270/5250).
- Values of attributes that are configured as write-only in the model.
Note: Before providing troubleshooting files to Attachmate or others, verify that sensitive data has been removed. Sensitive data may not be redacted in specific unusual configurations or host applications.
Providing Logs to Technical Support
You may be asked to provide the session server log to Technical Support. The default directory and file name are as follows:
- Windows: C:\Program Files\Attachmate\Verastream\HostIntegrator\etc\logs\server\message.dat
- Linux/UNIX: /opt/attachmate/verastream/hostintegrator/etc/logs/server/message.dat
We recommend that you zip (compress) log files before sending them. If you are already working with Technical Support, see the instructions at https://support.microfocus.com/kb/doc.php?id=7024990 on how to upload any files gathered. If you experience issues with getting the FTS credentials from the Support Portal, contact your Support Engineer who can assist and provide the URL, username, and password for the upload.
Viewing Logged Messages
Once you have captured a log file, use one of the following methods to filter and view the log.
Administrative Console Logs View
In the Administrative Console application, click View > Logs to enable the Logs view tab.
This log viewer uses SQL-type queries to filter logged messages. The default query displays all logged messages:
select * from messagesIf you are unfamiliar with SQL, click the "Build a Query" button to the right of the query edit field (containing a small wrench). Example:
select * from messages where (severity = 'Error' or severity =
'Warning' or severity = 'Info') and (msgtime >= timestamp '2013-3-26
15:0:0') and (msgtime <= timestamp '2013-3-26 16:15:0') and model =
'Pool_1'To execute your query, click the "Run the Displayed Query" button to the left of the query edit field (containing a green "play" triangle icon).
For more information about using SQL queries, see http://docs2.attachmate.com/verastream/vhi/7.5/en/topic/com.attachmate.vhi.vmc.help.online/tasks/vhi_mc_build_queries.xhtml.
Log Export Utility
The logexport command line utility allows extracting messages suitable for parsing or importing into third-party applications. Similar to the Administrative Console Log View, logexport accepts SQL query syntax. For more information, see http://docs2.attachmate.com/verastream/vhi/7.5/en/topic/com.attachmate.vhi.vmc.help.online/tasks/vhi_mc_export_logging.xhtml.
Operating System Logs
If you enabled System Logging (in step 7 of Enabling VHI Logging), you can use a utility to view the operating system log:
Windows: Control Panel > Administrative Tools > Event Viewer > Application Log
Sun Solaris: /var/adm/messages
Red Hat Linux: /var/log/messages
IBM AIX: log location configured in /etc/syslog.conf (e.g., *.debug or daemon.error line)
Third-party utility: syslog-monitoring package such as NetIQ AppManager, NetIQ Security Manager, or BMC PATROL (BMC Performance Manager)
Above references to third-party vendors or products are informational only and should not be construed as certification, endorsement, or recommendation by Attachmate.