File Content Extraction 25.4
Filter SDK Python Programming Guide

# Enable Diagnostic Logging

You can enable logging in File Content Extraction to diagnose issues that might occur. You configure logging in the `formats.ini` configuration file, by creating a `[Logging]` section.

CAUTION: Turning on logging can slow File Content Extraction down and quickly generate many large log files. OpenText recommends that you turn on logging only when you need to diagnose a problem, in conjunction with OpenText technical support.

The `[Logging]` configuration uses the same format as File Content Extraction standard logging. In most cases, the following configuration is sufficient:

    [Logging]
    LogDirectory=./logs
    0=FilterLogStream

    [FilterLogStream]
    LogFile=filter
    LogTypeCSVs=Filter

In the `[Logging]` section you set general parameters to apply to all log streams and define the names of your log stream section. You then define a section for each log stream, which contains settings for only that log stream.

The following table contains more details about the logging configuration parameters.

Parameter Name | Description
--- | ---
`LogArchiveDirectory` | The path to a directory to use to archive old log files when `LogOldAction` is set to Move.
`LogDirectory` | The path to the directory to use to save log files. Relative paths are relative to the `bin` directory.
`LogEcho` | Set this parameter to True to display logging messages on the console.
`LogExpireAction` | The option to use to expire logs when they exceed the maximum size set by `LogMaxSizeKBs`. Use one of the following options: Consecutive. The log file name is appended with a number and saved in the log directory. Each log file is numbered with the next consecutive number. Datestamp. The log file name is appended with a timestamp and saved in the log directory. Previous. The log file name is appended with `.previous` and saved in the log directory. Every time the log file reaches the maximum size, it overwrites the old log file.
`LogFile` | A file name prefix to use for all the log files that File Content Extraction creates for this log stream. File Content Extraction uses this prefix with the process ID and session to identify log files for each of your sessions.
`LogHistorySize` | The number of log messages to store in memory. The maximum value is 520.
`LogLevel` | The type of message to log. Use one of the following options: Normal. Errors and basic processes are logged. Error. Errors are logged. The default value is Normal, when you enable logging.
`LogMaxLineLength` | The maximum number of characters to allow in a log entry before it is truncated. You can increase this value when you need to log long actions in full. The maximum allowed value is 2000000000, but OpenText recommends that you set the value lower than 1000000.
`LogMaxOldFiles` | The maximum number of log files to store in the log directory. When this value is exceeded, File Content Extraction applies the `LogOldAction`.
`LogMaxSizeKBs` | The maximum size of log files, in kilobytes. When this value is exceeded, File Content Extraction applies the `LogExpireAction`. NOTE: File Content Extraction creates a separate log for each session and each kvoop process. With the default kvoop settings, the kvoop log is unlikely to reach the maximum log size before File Content Extraction refreshes the process, so the logs might not be expired.
`LogOldAction` | The option to use to handle log files when the number of log files exceeds the value set by `LogMaxOldFiles`. You can use one of the following options: Delete. Delete old log files. Move. Move old log files to the `LogArchiveDirectory`.
`LogOutputLogLevel` | Set this parameter to False if you do not want to include the log level in the log entry.
`LogOutputSeverity` | Set this parameter to False if you do not want to include the severity rating in the log entry.
`LogSysLog` | Set this parameter to True to write messages to the Linux Syslog or Windows Event Log.
`LogTime` | Set this parameter to False if you do not want to include the current time in the log entry.
`LogTypeCSVs` | The type of logs to create. You must set this option to Filter.

For more information about File Content Extraction logging, refer to the Help for a File Content Extraction component, for example the Content Component Help.

Copyright 1997-2025 Open Text
Version 25.4 | Last updated October 2025

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: File Content Extraction 25.4

Topic Title: Enable Diagnostic Logging