Minecraft
The Analyse plugin for Paper, Folia, Spigot, Velocity and BungeeCord: install, commands, config and the developer API.
The Analyse plugin tracks joins, sessions, server health and in-game purchases on your Minecraft server or network, and brings your stats into the game with /analyse.
What it collects automatically
| Event | When | Details |
|---|---|---|
| Join | A player joins | Name, IP (for country), the hostname they connected with, Java or Bedrock |
| Leave | A player leaves | Quit, kick or ban |
| Server startup, heartbeat, shutdown | Server lifecycle | Players online |
| Tick rate | Every 60 seconds on backends | TPS over 1, 5 and 15 minutes and MSPT |
| Commands | A player runs a command | The command name only, never arguments |
| Chat | Off by default | Message (first 256 characters) and length |
Bedrock players are detected through Floodgate when it is installed.
Events are sent in the background, never on the server thread, and batched every 5 seconds by default.
In this section
- Install the plugin: pick the right jar, add the key or pair with
/analyse connect, and set up networks. - Commands and permissions: stats in chat or menus, recording payments and custom events.
- Configuration: every
config.ymloption. - Developer API: send your own events and player properties from another plugin.
In this section
Install the pluginWhich jar to use for Paper, Folia, Spigot, Velocity and BungeeCord, how to connect it and how to run it on a network.Commands and permissionsEverything /analyse can do in game and in the console, and the permissions that control it.ConfigurationEvery option in config.yml, plus messages.yml and the menu files.Developer APISend custom events, player properties and purchases from your own Bukkit plugin through the Analyse client.Import from Plan and DomainStatsBring your history over from Plan: Player Analytics and turn your DomainStats sources into campaigns.