Skip to content

BX-Team/Pulsify

Repository files navigation

Pulsify

Lightweight server monitoring SDK for Minecraft. Captures errors, tracks player events and custom metrics, and ships them to the Pulsify backend — across Paper, BungeeCord, and Velocity.

website Available on Modrinth Chat on Discord

⚠️ Notice

Pulsify is a new project and is currently in beta phase.
We are actively developing and improving project with new features and optimizations.

⚙️ Features

  • 🐛 Automatic error capture via Log4j2 or JUL with stack traces
  • 📊 Custom metrics with optional label support
  • 👤 Player join/quit event tracking
  • 💓 Periodic server heartbeats with server and plugin info
  • 📦 Batched event queue with configurable flush intervals
  • 🔌 Multi-platform: Paper, BungeeCord, Velocity (mod support coming soon)

🎮 Setup for Server Owners

If you are a server owner looking to connect your server to Pulsify, follow these steps:

  1. Head over to bxteam.org/dashboard.
  2. Open your project and go to its settings.
  3. Come up with a name and generate a new DSN key.
  4. Paste the DSN key into the plugin configuration file on your server.
  5. Restart your server to apply changes!

That's it! Your server should now be connected to Pulsify, and server stats, player events, and errors will start appearing on your dashboard.

🚀 Quick Start for Developers

Initialize the client once during plugin startup:

StatClient client = StatClient.builder()
    .dsn("your-dsn-here")
    .autoCollectErrors(true)
    .build();

Capture errors and metrics manually:

// Report a caught exception
client.error("my-plugin", exception);

// Send a custom metric
client.metric("tps", server.getTPS()[0]);

Close the client on shutdown to flush pending events:

client.close();

📦 Building

To build Pulsify, follow these steps (Make sure you have JDK 17 or higher):

./gradlew build
  • Platform jars will be located at platforms/<platform>/build/libs/.

⚖️ License Static Badge

Pulsify SDK is licensed under the GNU General Public License v3.0. You can find the license here.

About

Observability platform for servers and plugins. Track TPS, player sessions, errors, and custom metrics in a real-time dashboard

Resources

License

Stars

Watchers

Forks

Contributors

Languages