OpenFin logs

OpenFin maintains two distinct logs associated with the OpenFin platform:

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

These logs can help diagnose 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.

Runtime log default location

Runtime logs are located in:
%localappdata%\OpenFin\cache\<runtime version>\debug.log

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

Runtime log configuration

Available options for Runtime logs:

Runtime log 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 runtime 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 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 related to network, OpenFin environment, and application start up activity.
RVM logs can be useful in detecting environmental and desktop variables impacting an application during its start up sequence.

RVM log default location

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

RVM log configuration

Available options for RVM logs:

RVM log 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.

RVM log format

RVM log messages have the following format:

Timestamp | Thread#:ProcessID | Type | Name | Description

Timestamp: The timestamp represents the date and time when the message was produced. The format is YY-MM-DD HH:MM:SS:MS.
Thread#:ProcessID: This value represents the identifier of the thread that produced the log message. You can use it to distinguish activity from different applications that are running simultaneously.
Type: There are four types:
- ERROR: A feature is not working properly
- WARNING: A non-disruptive error that does not prevent the application from running
- INFO: Information about the current state of the application
- VERBOSE: Detailed information about the application's configuration and settings
Name: The categories of the log message. The names are based on the name of the class that generates them. GENERAL represents general information rather than a specific class name.
Description: An explanation of the reason for the log message.

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

Application log 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\.

Application log configuration

Available options for Application logs:

Log Uploader tool

Starting in version 40, you can use the Log Uploader tool to retrieve logs from end-user systems.

Support articles

Runtime
RVM