Class DebugLogging

Debug Logging

Many portions of the internals are helpfully instrumented with logging. This instrumentation is always removed from production builds.

Log instrumentation is "regionalized" to specific concepts and concerns to enable you to enable/disable just the areas you are interested in.

To activate a particular group of logs set the appropriate flag to true either in your build config or via the runtime helper.

Activation Via Runtime Helper

A runtime helper is attached to globalThis to enable activation of the logs from anywhere in your application including from the devtools panel.

The runtime helper overrides any build config settings for the given flag for the current browser tab. It stores the configuration you give it in sessionStorage so that it persists across page reloads of the current tab, but not across browser tabs or windows. Thus if you need to deactivate the logging, you can call the helper again with the same flag set to false or just open a new tab/window.

Example Usage:

setWarpDriveLogging({
  LOG_CACHE: true,
  LOG_REQUESTS: true,
})

Activation Via Build Config

setConfig(__dirname, app, {
  debug: {
    LOG_CACHE: false, // data store received to update cache with
    LOG_NOTIFICATIONS: false,
    LOG_REQUESTS: false,
    LOG_REQUEST_STATUS: false,
    LOG_IDENTIFIERS: false,
    LOG_GRAPH: false,
    LOG_INSTANCE_CACHE: false,
    LOG_METRIC_COUNTS: false,
    DEBUG_RELATIONSHIP_NOTIFICATIONS: false,
  }
});