Usage stats

What Playkeeper counts about each machine, when it sends it, what the stats service keeps, and the switch or variable that turns it off.

From README.md in the repository, for Playkeeper 0.4.17.

From 0.4.4, Playkeeper counts how many machines run it, anonymously, so the project knows how many people use it and where to spend its time. The installer says so before it sends anything. Each machine sends exactly this, and Settings › Playkeeper › Usage stats shows yours field for field:

Field What it is
id a random ID made on the machine for usage stats alone, tied to nothing else
version the Playkeeper version, like 0.4.4
os, osVersion the system and its release, like ubuntu and 24.04
arch the CPU type, amd64 or arm64
source how Playkeeper got onto the machine: playkeeper.io (the install command there), github (get.sh straight from GitHub), mirror (get.sh from another location), tarball or source (a build that isn't a release)
channel the code of a playkeeper.io/install/<code> command, if one was used
kind dashboard, or joined for a machine connected to another dashboard
test marks the project's own test installs, which aren't counted
event, step from the installer: started once you accept its plan, then succeeded, or failed and the step that failed; or refused and the checks that turned it away, like memory, or existing-service-stopped for another Minecraft setup and its kind, or installed when it runs where Playkeeper already does
address from a running machine: free (a playkeeper.me name), own (your own domain) or ip (none)
servers, running from a running machine: how many Minecraft servers it has, and how many run
reached from a running machine, from 0.4.18: the furthest step of its setup, account (the dashboard's first account made), server (a server came online), played (someone played on one of its servers, you included) or friends (a second, different player did), never who or how many

The installer sends its reports while it installs, and nothing if you decline its plan. A running machine sends a heartbeat a minute after Playkeeper starts, then every 12 hours. From 0.4.16 a machine also sends one right after its first server comes online, and the dashboard's machine right after its first account is made, each only the first time, so the counts show how far a new install got even if its machine is gone within hours. From 0.4.18 it also sends one the first time someone plays on one of its servers, and the first time a second, different player does. They go to stats.playkeeper.io, the project's own service, whose code is in this repository (services/stats). It keeps each machine's random ID with what its reports say and the days it ran, never an IP address, and never learns a host name, a server name, or who plays or how many: only whether anyone has played yet, and whether a second player has.

Checking from the internet (from 0.4.18): a machine can't see its provider's firewall, so a server's Overview asks the same service whether friends can reach the server's port. The request names only the port, with no ID. The service connects back to the address the request came from, on that port alone, and asks for the server's status the way a game's server list does, reading no more of the answer than shows a Minecraft server answered, so never the players. It keeps nothing of a check. While usage stats are on, the Overview checks by itself, at most once an hour; with them off, it checks only when someone presses Check from the internet.

To turn usage stats off:

  • Settings › Playkeeper › Usage stats: one switch for every machine of the dashboard.
  • When installing: curl -fsSL https://playkeeper.io/install | sudo DO_NOT_TRACK=1 sh sends nothing, and the machine keeps them off; the switch can't turn them back on. PLAYKEEPER_USAGE_STATS=off does the same. Put the variable after sudo, which drops variables set before it.
  • For a machine that's installed: sudo systemctl edit playkeeper-agent, add Environment=DO_NOT_TRACK=1 under [Service], then sudo systemctl restart playkeeper-agent.

Can't find it?

Ask in GitHub Discussions. Answers are public, so the next person finds them too.

Ask in GitHub Discussions