Skip to main content

telemetry

The telemetry configuration controls OpenKeyNav's version support event.

What OpenKeyNav sends​

On non-localhost pages, the default configuration sends this JSON body to applicationsupport.openkeynav.com:

{
  "properties": {
    "version": "<OpenKeyNav version>"
  },
  "event": "openKeyNav.js version ping"
}

The JSON body contains exactly the installed OpenKeyNav version and the fixed event name shown above.

The receiving infrastructure also sees ordinary network metadata such as the source IP address. Organizations can set telemetry.enabled to false when their policy calls for zero outbound version-support telemetry.

Disable telemetry​

Telemetry is enabled by default. Set telemetry.enabled to false during initialization to prevent the request:

const openKeyNav = new OpenKeyNav();

openKeyNav.init({
  telemetry: {
    enabled: false,
  },
});

Setting telemetry.enabled to false keeps version-support requests at zero.