OpenFin logs

OpenFin maintains two distinct logs associated with the OpenFin platform:

  • Runtime Log | debug.log
  • RVM Log | rvm.log

These logs are beneficial when diagnosing unexpected behaviors with an application running in OpenFin.

Runtime log

The file debug.log contains output log messages from both the Runtime and corresponding applications (unless configured not to) leveraging that Runtime version. The messages in these logs are a combination of Chromium, Electron, OpenFin and your application's console messages.

Default location

Runtime logs are located in:
%localappdata%\OpenFin\cache\<runtime version>\debug.log
When a security realm is being used, it is part of the path to the runtime logs:
%localappdata%\OpenFin\cache\<security realm>*\<runtime version>\debug.log

Configuration

Available options for Runtime logs:

Lifecycle

Runtime debug logs are created on Runtime startup from an application launch. Log messages are written to the file debug.log until that Runtime instance has closed down. On Runtime close, the debug log file name is updated with a timestamp. The last 7 debug logs for that Runtime version are retained on the local file system.

Format of log entries

Prior to version 26, the format of log entries in the Runtime debug log was:
[YYYY-MM-DD HH:mm:ss.ms]-[TYPE:filename.ext(line#)] log message

Starting in version 26, log entries now contain the process's identifier at the beginning of the line:
[processID:MMDD/HHmmss.ms:TYPE:filename.ext(line#)] log message

The process ID enables you to determine which log entries were emitted by various subprocesses of the OpenFin Runtime. You can check these values against information from Task Manager or Process Explorer to determine exactly which subprocesses the IDs are associated with.

For example, prior to v26, it was difficult to detect "delegated launches" in the log. That is, in cases where two OpenFin applications specify the same runtime version, the second one that starts generates a short-lived runtime that delegates to the first-launched runtime instance and then closes. Starting in v26, you can see this situation in the log, via multiple log entries where the message is the same but the process ID is different; the duplicate entries are created by the second runtime instance. Following them is an entry from the first runtime process with the message handling delegated launch with the following args; the next entry contains the arguments that the second runtime was launched with, which are now being handled by the first runtime.

RVM log

The file rvm.log contains output log messages from the RVM. These messages consist of Network, OpenFin Environment and application start up. RVM logs can be useful in detecting environmental and desktop variables impacting an application during its start up sequence.

Default location

RVM logs are located in:
%LocalAppData%\openfin\logs\rvm.log

Configuration

Available options for RVM logs

Lifecycle

RVM logs are created on an application launch. Log messages are written to the file rvm.log until the RVM has exited. This occurs when the last Runtime instance has closed. On RVM close, the RVM log file is zipped and stored in the OpenFin\logs\archive\ folder with a timestamp. The last 10 RVM logs are retained on the local file system.

Application logs

Application logs (app.log) are created on application startup and periodically written to log by the Runtime. In the RVM’s installation directory in the app’s subfolder. More Information

Default location

Application logs can be found in
%LocalAppData%\openfin\apps\<app>\app.log.

Archived application logs can be found in
%LocalAppData%\openfin\apps\<app>\archive\.

Configuration

Available options for Application logs

Support articles


Related topics
Did this page help you?