ServersPulse Documentation
ServersPulse is a real-time monitoring platform for Minecraft servers. A lightweight agent plugin runs on your server and streams performance snapshots to the dashboard, giving you continuous visibility into TPS, MSPT, memory usage, player activity, and more.
Core features
- Real-time metrics -- TPS, MSPT, memory, online players, and per-world entity/chunk breakdowns streamed via WebSocket
- Alert rules -- Configurable metric thresholds and preset templates that create incidents and notify you through Discord or webhooks
- Incident tracking -- Automatic detection of TPS drops, crashes, high memory, offline states, player spikes, and more
- Player analytics -- Per-player session tracking, join counts, playtime, platform detection, and domain-based acquisition tracking
- Retention reports -- Daily cohort analysis showing D1, D7, and D30 player retention by platform
- Weekly reports -- Automated performance summaries with week-over-week comparisons (Pro and Multi plans)
- Team access -- Invite teammates with role-based permissions (Viewer, Alert Manager, Operator, Owner)
- Discord bot -- Link your Discord guild to receive alerts, check server status, and manage incidents from chat
- Data exports -- Export metric history as CSV or JSON (Pro and Multi plans)
- Multi-platform support -- Bukkit, Paper, Folia, Fabric, Forge, and NeoForge
Documentation sections
| Section | What you will find |
|---|---|
| Getting Started | Account creation, first server setup, verifying data flow |
| Installation | Plugin placement, registration codes, and platform-specific steps |
| Configuration | Plugin config keys, polling intervals, reload behavior |
| Dashboard Guide | Reading metrics, charts, time ranges, and server overview |
| Alerts | Creating rules, metric thresholds, presets, incidents, Spark profiling |
| Players & Retention | Player tracking, sessions, retention cohorts, domain tracking |
| Reports & Exports | Weekly reports, CSV/JSON exports, report contents |
| Team Access | Roles, capabilities, invites, and member management |
| Discord Bot | Bot setup, guild linking, available commands |
| Plans & Billing | Plan comparison, upgrading, billing portal |
| FAQ | Common questions about setup, data, plans, and troubleshooting |
Supported platforms
The ServersPulse agent plugin supports the following Minecraft server platforms:
- Bukkit / Paper / Folia -- Drop the jar into
plugins/ - Fabric -- Place the mod into
mods/ - Forge -- Place the mod into
mods/(1.16.5, 1.20.1, 1.21.1, 1.21.11+) - NeoForge -- Place the mod into
mods/(1.20.6+)
Quick start
- Create an account and log into the dashboard
- Create a server entry and copy the registration code
- Download the plugin for your platform
- Drop it into your server's
plugins/ormods/folder - Start the server and run
/serverspulse register <code> - Open the dashboard and verify metrics are streaming in
For detailed steps, see the Getting Started guide.
Contributors
Thanks to everyone who keeps this docs area accurate.
