KeyView 24.4
KeyView Filter SDK C Programming Guide

# Legacy Out-of-Process Session Logging

IMPORTANT: Out-of-process session logging is available only when you configure KeyView to use the legacy out-of-process method. See Use the Legacy Out-of-Process Method.

Logging is available for out-of-process filtering. The `kvoop` server can create a log file that captures information on the files being processed, storing one entry per session (process). The generated log file is called `xxxx_kvoop.log`, where `xxxx` is a unique number identifying the session.

In the rare case when the `kvoop` server fails, you can use the log files to determine which file caused the failure.

## Enable Legacy Out-of-Process Session Logging

To enable out-of-process session logging, set the `KVOOP_LOGS_DIR` environment variable to the directory in which you want the log files to be stored. By default, session logging is not enabled.

On UNIX, set the variable as follows:

    setenv KVOOP_LOGS_DIR /tmp

On Windows, set the variable as follows:

    set KVOOP_LOGS_DIR=c:\tmp

The following log file is created in the directory:

`process_id_kvoop.log`

where `process_id` is a numeric value that represents the logged process.

If KeyView terminates unexpectedly and Windows minidump is enabled, a `process_id_crash_info.txt` file is generated (see Enable Windows Minidump). If logging was not enabled at the time of termination, this file contains instructions on how to enable logging.

## Set the Verbosity Level

To control how much information is written to the log, set the `KVOOP_LOG_VERBOSITY` environment variable to one of the following values.

`1` | Include only error messages.
`2` | Include errors and warnings.
`3` | Include errors, warnings, and general information. This is the default.
`4` | Include all possible information. This setting is useful for debugging purposes.

## Enable Windows Minidump

KeyView can use the Windows minidump feature to provide additional logging information, which can be useful for debugging purposes.

The Windows minidump is disabled by default. To enable the Windows minidump, set `KVOOP_DUMP_ENABLE` to `1`. If an unexpected termination occurs after the minidump is enabled, three files are generated:

- `process_id_crash_info.txt`. This file contains `KVOOP` state and runtime information at the time of termination. If logging was not enabled at the time of termination, this file contains instructions on how to enable logging.
- `process_id_process_list.txt`. This file contains information from the DLLs that were loaded at the time of the termination.
- `process_id_report.dmp`. The Windows dump file, which contains further information about the termination. You can open it with either a Windows debugger or `autnhelper.exe` (you must copy this file to the same directory).

You can control the amount of information presented in the Windows dump file by creating the following files in the directory:

    dumper.NORMAL
    dumper.WITHDATASEGS
    dumper.WITHFULLMEMORY
    dumper.WITHHANDLEDATA

Copyright 1997-2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.4

Topic Title: Legacy Out-of-Process Session Logging