Document Actions
11.
Logging
Up one level
The Go-Between may optionally create a log file as it runs. This will generally not be useful to users, but will usually be useful when reporting problems to OpenEngagement. Usually, there is no harm in having the Go-Between set to always create log files. However, there are a few possible concerns:
1) The log files may get large. This is very rarely a problem, however, since the log file is deleted and re-created each time Working Papers is restarted.
2) Logging may cause some performance penalty. However, this will be very small compared to the time to upload and download files, and should not be noticeable.
3) The log files may contain user passwords unless the user specifies to not include passwords. If passwords are included, the passwords are in Base64 format, which is quite easy to decode. This may be a concern for some users, though where the log files remain on the computer on which they are created, the username and password are available only to persons with access to this computer.
The log files track three things:
1) Errors
2) Function calls.
3) Communication calls.
The first, errors, are always logged if logging is enabled. The other two must be optionally enabled by the user in order for them to be logged. Users may search the log file themselves for errors by searching for the words FAULT, ERROR and ASSERT. Otherwise, tracking function calls and communication calls will be useful only for sending the log to OpenEngagement for debugging.
The Go-Between uses two internet protocols, HTTP/HTTPS and XMLRPC to communicate with the OpenEngagement DMS. Dumps from these protocols will be included in the log file if logging communication is enabled. In this case, OpenEngagement will also create an HTML file each time the Go-Between uploads an engagement. These HTML files will contain the response to the upload operation.
Logging is enabled by using a file called oe.ver. This file, if it exists, should be in the same directory as the Go-Between dll file, dms.dll. If it does not already exist, users may create one. One will be placed in this directory when the Go-Between is installed.
sample oe.ver file:
logging=1
log_communication=1
log_function_calls=1
hide_passwords=1
Users may also specify log_path, for example: log_path=c://go-between.txt. If log_path is not specified, the log file will be placed in a /log folder within the folder in which Go-Between is installed.
When hide_passwords is set to 1, the log file will list '<password>' or '<username/password>' instead of the actual password.