OpenFin API diagnostics

OpenFin API diagnostics is a feature that collects anonymized data about API usage. OpenFin analyzes this data to understand what APIs are being used, and at what frequency, within customer environments. This analysis enables OpenFin to make more informed decisions in product development.

How data is collected

When API diagnostics is enabled, the following happens:

  1. Each time an OpenFin API is called, a count for that API is incremented. For example, fin.Window.moveTo() or fin.Application.create().
  2. When an application is closed, the data is saved to a file on the local filesystem.
  3. The diagnostic files are delivered to OpenFin’s secure file server daily, between 1:00 A.M. and 2:00 A.M., local time.

No proprietary or sensitive data is collected; all that is captured is the fact that an OpenFin API function was called.

Application providers

API diagnostics data collection is enabled by default. If you want to opt out of this feature for your application, set the apiDiagnostic option to false in the application manifest. This option is a member of either startup_app or platform, depending on which is appropriate for your application.

{
    "platform": {
        "name ": "OpenfinPOC",
        "uuid": "OpenfinPOC",
        "applicationIcon": "http://localhost:5555/favicon.ico",
        "autoShow": false,
        "apiDiagnostics" : false
    },
    "runtime": {
        "version": "stable"
    }
}
{
    "startup_app": {
        "name": "OpenfinPOC",
        "url": "http://example.com:5555/index.html",
        "uuid": "OpenfinPOC",
        "applicationIcon": "http://example.com:5555/favicon.ico",
        "autoShow": true,
        "saveWindowState": true,
        "apiDiagnostics" : false
    }, 
   "runtime": {
        "arguments": "",
        "version": "stable"
    }
}

Desktop owners

Starting OpenFin Runtime v20, reporting of API diagnostic data is enabled by default. Data is collected for those applications that have not disabled it in their application manifest. Between the hours of 1:00 AM and 2:00 AM local time, RVM searches for any available analytics and send them to OpenFin.

If, as a desktop owner, you wish to opt out of collecting and sending diagnostic reports, you can turn it off in the desktop owner settings.

In the desktopSettings object, set the option enableRuntimeDiagnostics to false.


Did this page help you?