Skip to content

five-on-it / apps/api/src/telemetry

apps/api/src/telemetry ​

Telemetry and crash reports (the privacy policy's "with your consent" part): what a player's game sends once the player said yes on its first start (or in Settings → Privacy), and what a moderator reads of it.

  • POST /telemetry/crash: a crash report (its message, a stack scrubbed by the game of addresses, query strings and paths of the player's machine, the release, the platform, the renderer), open to anyone, size-capped, a few a minute per install.
  • POST /telemetry/events: a batch of usage events (a session, the level played, a mission begun, done or failed, the frame times), likewise.
  • GET /telemetry/crashes?days=: the moderators' view, the crashes grouped by fingerprint (their message and their first frames), the most frequent first.

Nothing names the player: an install id their game made (and lets them renew), never an account, an e-mail or an address (the request's own is not kept). Records are forgotten after FOI_TELEMETRY_DAYS (90 by default; purgeTelemetry, every hour). The counts go to Prometheus too (metrics.ts): crashes and sessions by release and platform, frame times.

Interfaces ​

Type Aliases ​

Variables ​

Functions ​