OpenFin Logging (RVM and Runtime Logs)

Overview

This article provides an overview of the logging provided by the two core OpenFin Components:

• Runtime Version Manager (RVM) - Responsible for managing assets and bootstrapping an application
• Runtime  - Responsible for rendering the application

Runtime Version Manager (RVM)

The OpenFin Runtime Version Manager (RVM) is responsible for Bootstrapping OpenFin Applications, managing application assets, and managing OpenFin Application shortcuts.  The RVM has been designed so only one instance is running at any time.  The RVM creates a log file in the following location:

%localappdata%\openfin\logs\RVM.log

It is not possible to customize the location of the RVM log.

The RVM log contains information about:

• Issues related to non-reachable Application Configuration Files
• Issue related to failed asset download and deployment, including:
  • OpenFin Runtimes
  • Application Assets Defined in the Application Configuration File
• Issues related to non-reachable Applications Start URLs
• Runtime start-up issues

Information regarding specific log messages can be found HERE.

Runtime

The OpenFin Runtime is the process responsible for rendering the application.  Each running Runtime process with output logs to its own file, applications sharing a Runtime version will output logs to the same file unless the application has configured a Security Realm.  Log statements made by an application will be output to the runtime debug log unless an Application Logging has been enabled, which is outlined later in this document.  Each Runtime version created the following Log File:

<runtimeCache>\<security realm>*\<runtime version>\debug.log

*If an application has not specified a security realm this folder level will not apply

The runtimeCache is configurable, the default location of the runtimeCache is:

%localappdata%\openfin\cache

Runtime Verbose logging (Default Disabled)

In some cases, it will be required to increase the verbosity of a Runtime debug log.  The following article includes information on the options available to enable verbose logging: Enabling Runtime Verbose logging

Net Logging (Default Disabled)

In some cases, it will be required to examine the network messages sent by the OppenFin runtime.  The when active the data is written to a separate file, the location, and name of the file is specified when enabling NET logging.  The following article explains how to enable NET logging: Enabling Net Logging

Application Logging

By default, all application logging will be output to the Runtime Debug log.  Application logging can be segregated from the runtime logging by enabling Application logging.  

Application Logging can be enabled by the application developer by adding the following to the `startup_app` object in the application configuration file:

{
    "startup_app": {
          "enableAppLogging": true,
    }
}

 Once enabled all Application logging will be output to:

<runtimeCache>\app\<app-name>-<app hash>\app.log 

When using the api Application.sendApplicationLog you can configure your application manifest to send application logs to another location rather than the default endpoint (AWS).

Your application manifest would need to look like this:

    "logManagement": {
      "enabled": true,
      "url": "<YOUR_URL_ENDPOINT>/api/v1/logs"
    }

Runtime Log Management

OpenFin offers a feature that allows an application to send the application log to an OpenFin hosted central server, which can then be retrieved by the application owner using the Log Management CLI .

For full details about the OpenFin Log Management feature see the full documentation HERE.

Programmatic Log Reading

The OpenFin API provides the System.getLog() method that enables you to programmatically ready the content of the Runtime log from within an application.