Filters for Logs

enaio® 11.10 »

In the oxrpt.cfg configuration file, you can specify a separate filter configuration for each channel using the FilterName parameter.

There is an oxrpt.filters.cfg configuration file in the installation directory, which can be used to filter the logging results down to relevant log entries while writing. This can significantly reduce the runtime required for logging and the amount of data generated. For analysis purposes, it is therefore possible to enable the logging of a enaio® application while in live operation.

This is particularly relevant for enaio® server, though it can also be used for client and admin components to create clearer log files.

You need detailed knowledge of the system to configure filters. Filters are generally applied in collaboration with the support team to analyze errors.

The oxrpt.filters.cfg configuration file is an INI file in which filter configurations can be stored for one or more log channels.

The configuration file may contain several sections. The sections either take the name of a channel, e.g., [Flow Log], or the name that is specified via the FilterName parameter when a channel is configured.

Example:

[myfilter]
000 = - # oxmljsc # * # *
001 = - # axavapps # * # *
002 = - # * # vbscript.cpp # *
003 = - # ax # * # CMainFrame::TranslateRibbonBar

With consecutive numbering, entire modules (in this example: oxmljsc), areas in modules, vbscript.cpp, and individual functions (CMainFrame::TranslateRibbonBar) are excluded from logging.

Instead of excluding modules, areas, and functions, as in the example here, a filter can be used to restrict logging to modules, areas, and functions: 000 = + # oxmljsc # * # *

For all setting levels, modules, areas, and functions, the placeholder '*' can be used to specify several elements, e.g., CMainFrame::*.

Additional Filtering for enaio® server

In addition to the filter settings outlined above, namespaces from enaio® server that are not relevant for enaio® server with job filtering can be excluded from logging. This also allows you to further reduce the size of the generated logs, making it possible to activate them for longer periods of time to track relevant areas in the server execution outside of error logging.

Job filtering supersedes the filter settings made via oxrpt.filters.cfg. This means that namespaces that are excluded by means of job filtering are not logged, regardless of the settings made in oxrpt.filters.cfg. Moreover, flow logging must be activated in oxrtp.cfg before the settings of the other two configurations can take effect. enaio® server must be restarted to apply changes made to oxrpt.filters.cfg and oxrpt.jobs.cfg. These files are not read again at runtime.

Job filtering is configured in the oxrpt.jobs.cfg file, which is installed in the server directory. This type of log filtering is disabled by default, as this file does not contain any active settings with the installation.

This file contains the following in order, for example, to exclude a variety of non-relevant executors from logging at this point:

[Jobs]
cnv.* = 2
mng.* = 2
ado.* = 2
std.* = 2
vtx.* = 2
abn.* = 2

Values:

  • 0 – For internal jobs: logged when called by a logging job
    For external jobs: logging of this job activated

  • 1 – Logging of these jobs is activated

  • 2 – Logging of these jobs is deactivated

For namespaces that are not listed in oxrpt.jobs.cfg, the default setting is 0, i.e., the jobs from these namespaces are logged.