Event & Log Tracking

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. To opt out, set analytics.webVitals to false:

const overlay = overlayed({
	// ...
	analytics: {
		webVitals: 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:

const overlay = overlayed({
	// ...
	analytics: {
		crashes: 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

overlay.cortex.track("my_custom_event", {
	someData: "some_data",
});

Get Started

Essentials

Windows

Keybinds

Notices

Feature Flags