Skip to main content
Event & log tracking can be useful for a variety of reasons:
  • Tracking an influx of events for a new release
  • Analytics purposes like observing user behavior
  • Retrieving logs tied to a specific issue or session
By default, Overlayed tracks a number of events that are surfaced via the Overlayed Dashboard:
  • game_launch
  • game_close
  • game_session_end (one per game session, with its duration and whether the game became ready)
  • web_vitals (see Web Vitals)
And logs like:
  • fatal
  • error
  • warning

Web Vitals

Windows created with overlay.windows.createWindow or overlay.windows.createInGameWindow report Core Web Vitals as a web_vitals event once per page load, as long as the window’s preload script imports @overlayed/app/preload. FCP and LCP are left out when the paint they measure waited for the window to be shown. A window created with show: false and opened later, for example a window created at startup and shown when the user first opens it, can paint while hidden but only puts that paint on screen once it’s shown, so its FCP and LCP would measure how long it stayed hidden. That page load still reports TTFB, CLS and INP. A window shown as soon as it’s ready, such as on ready-to-show, reports FCP and LCP as usual, and so does a visible window whose frames are slow to reach the screen. To opt out, set analytics.webVitals to false:

Crashes

Overlayed reports app crashes, such as window and process crashes, uncaught exceptions in the main process, and sessions that ended unexpectedly. Crash reporting only observes these; it doesn’t change how your app handles them. Home directories are removed from error messages before they’re sent, but avoid putting user data into error messages. To opt out, set analytics.crashes to false:

Tracking Custom Events

We expose this functionality so that you can track custom events from your application, and tie the data into your dashboard.

track