Logging
Edit the file oxrpt.cfg to configure the logging process for enaio® applications. It can be found in the respective installation directories of the server and the client components.
No further changes are needed here after successful installation. The matching configurations in the directories of the Client, Capture, Admin, and Server installations correspond to the customized default settings optimized for the relevant applications.
Changes to the logging configurations can be made in the project using the axrptcfg.exe configuration tool in the relevant installation directory.
The installed log files contain a variety of log channels:
Channel |
Action ID |
Setup |
Description |
---|---|---|---|
Error |
8 |
Server, Client, Admin, Capture |
Log entries are only generated in the event of a program error. This channel is active by default for Admin and Server, but not for Client and Capture. |
Flow |
15 |
Server, Client, Admin, Capture |
Continuous logging of all program activities. This channel is inactive by default and should only be activated if needed for the corresponding analysis periods as part of troubleshooting. |
SQL |
9 |
Server, Client, Admin, Capture |
Logging of SQL requests sent by the relevant module. This channel is inactive by default and should only be activated if needed for the corresponding analysis periods as part of troubleshooting. |
Job call |
7 |
Server |
Logging of server job calls by the clients. This channel is inactive by default and should only be activated if needed for the corresponding analysis periods as part of troubleshooting. |
HTTP |
2 |
Server |
Logging of HTTP requests between the server and microservices. This channel is inactive by default and should only be activated if needed for the corresponding analysis periods as part of troubleshooting. |
ODBC |
14 |
Server |
Logging of the results data for a database query from the server to the database. This channel is inactive by default and should only be activated if needed for the corresponding analysis periods as part of troubleshooting. |
The following parameters are used to control a log channel and can be configured in the project if necessary:
Parameter |
Scope |
Effect |
---|---|---|
Level |
per channel |
Log level, values between 0 (errors only) and 6 (maximum). |
Suspended |
per channel |
Logging active/inactive |
LogLongTerm |
per channel |
Fast logging via a permanently opened file or by logging multiple applications in a shared file. Fast-logging files cannot be deleted as the application that is currently writing to the log holds a handle to the files. |
per channel |
Name of the log file. |
|
FilterName |
per channel |
|
LogRecreate |
per channel |
The running log file is closed at midnight and a new one is started at the beginning of the new day. |
LogMaxFileSize |
per channel |
Maximum file size of the generated log files in kilobytes. A new log file is written when this limit is reached. |
LogSizeControl |
per channel |
The size of the log directory is governed by enaio®. |
LogHighWater |
per channel |
Maximum allowable size of all log files per channel in MB. |
LogLowWater |
per channel |
Minimum size of all log files per channel in MB. |
LogExpirationDays |
per channel |
Value in days. Files are not deleted until the low water mark is reached. Instead, the most recent files are still available after several days. |
LogPath |
Cross-channel |
Path of log files. |
Defaults
During installation, the paths for log files are set to {InstallDir}\log. It may make sense to change this path for client installations, depending on the installation path and user rights. The directory can be on a network drive, but we do not recommend this for flow logging and LogLongTerm logging as this may impair performance.
Only the error logs are active in admin and server installations.
Applications | Channels | Name | LogLongTerm |
---|---|---|---|
Client/Capture |
Error log |
err_%2_%4%6%7%5.evn err_<app>_<user><ddmmyy>.evn |
Not active |
Flow log |
flw_%2_%4%6%7%5.evn flw_<app>_<user><ddmmyy>.evn |
Not active | |
SQL log |
sql_%2_%4%6%7%5.evn sql_<app>_<user><ddmmyy>.evn |
Not active | |
Admin | Error log – active |
err_%2_%4%6%7%5.evn err_<app>_<user><ddmmyy>.evn |
Not active |
Flow log |
flw_%2_%4%6%7%5.evn flw_<app>_<user><ddmmyy>.evn |
Not active | |
SQL log |
sql_%2_%4%6%7%5.evn sql_<app>_<user><ddmmyy>.evn |
Not active | |
Server | Error log – active |
err_%2_%6%7%5.evn err_<app>_<ddmmyy>.evn |
active |
Flow log |
flw_%2_%6%7%5.evn flw_<app>_<ddmmyy>.evn |
active | |
SQL log |
sql_%2_%6%7%5.evn sql_<app>_<ddmmyy>.evn |
active | |
Job call log |
log_%2_%6%7%5.evn log_<app>_<ddmmyy>.evn |
active | |
ODBC log |
odbc_%2_%6%7%5.evn odbc_<app>_<ddmmyy>.evn |
active | |
HTTP log |
http_%2_%6%7%5.evn http_axsvckrn_110624.evn |
active |
The default values apply for other properties, such as the maximum file size: LogMaxFileSize=12800 KB
Changes to Security System
You can activate additional logging of changes made to the security system in the 'Security system' and 'Remote user administration' areas in enaio® enterprise-manager.
Logging Services and Microservices
The logging of services – enaio® gateway and enaio® documentviewer – and microservices can be configured, independent of the configuration settings for logging enaio® applications.