What is it?
clan.me watches your server's TPS, memory, entities, and player activity around the clock. When something breaks, you get an alert that says what happened and where to look, before your players notice anything is wrong. All of this is free of charge.
What it does
Sends a heartbeat every 60s with: TPS, MSPT, memory, entities, chunks, sessions, deaths, chat rate, GC pressure, server config. By default it works with clan.me but you can change where it posts in the config file.
Installation
- Drop the JAR in /plugins
- Restart the server
- Open plugins/clan_me/config.yml
- Paste your plugin token from https://clan.me/dashboard
- Restart again (or /reload confirm)
Config reference
You can find out how to setup the plugin using this help centre article.
Compatibility
- Auto-detects /spark (even if built into Paper) and uses those figures first
- Bungee & Velocity support for network/proxy features
Requirements
Paper 1.21+. Now supports Spigot/CraftBukkit in seperate plugin in "Versions" section.
Optout
Players joining servers with this plugin installed see an optout message that directs them to an optout URL to anonymise their player/session info. This does not affect the analytics and alerts and is commonplace across server list websites for example that offer an optout system similar to this.
Open source
This server analytics plugin is open-source (MIT) and super easy to use in your own project. Just change the URL that it posts the JSON analytics details to in the config.yml file!
