Skip to main content

🛹Server Stats Plugin (Velocity, Bungeecord or Paper)

Custom server dashboard for server stats (Velocity or Bungeecord)

To add a dashboard with stats (for server details) follow these steps:

Requirements

  • First make sure your proxy / Paper server is the latest version
  • Download serverpulse Download the correct file depending on what you are running, so if you were running paper, download the paper.jar and if you are running bungeecord download the bungeecord.jar
  • make a account at influxDB

Setting up influxDB

  1. Create your account or login
  2. Follow the setup intructions (company name and organization)
  3. On the same page, choose a server the closest to you (US OR EU)
  4. Select the free account, you wont need more (for now)
  5. Click on "Manage Databases & security"
  6. Click on "GO TO BUCKETS" next to database manager.
  7. Press "Create a bucket"
  8. Give your bucket a memorable name
  9. keep the option on 30 days.
  10. At the top click "API TOKENS"
  11. Generate a api token (all access)
  12. give your token a brief description (or none at all) 13. SAVE YOUR API TOKEN, YOU WILL NEED IT. BY NOP COPYING IT AND NOT SAVING IT, YOU WILL NOT BE ABLE TO VIEW IT AGAIN

Setting up

  1. Upload the serverpulse.jar to plugins folder
  2. Start up the server (quick warning, the server will not start after the restart)
  3. go back to plugins then go to the serverpulse folder
  4. open the config.yml
  5. fill out the config like this:
url: # This is the url at the top of your page, it will looks like this: "https://eu-central-1-1.aws.cloud2.influxdata.com" it will be diffrent based on your location.
org: # This is your organsations name, please put exactly what you called your organisation. To view your organsation name, go back to influxdb click on your account name and click "Organisations"
bucket: # the name of your bucket, to view it go back to influxdb, click "manage databases and security" then go to database manager and then you can view your buckets.
token: # Your api token you copied / saved.
table: # call anything you want

After filling the config up, now restart you server.

Dashboard

  1. Go back to influxdb
  2. On the sidebar click the 4 squares (should say "dashboards" on hover)
  3. Create a dashboard
  4. Press "new dashboard"
  5. click "add cell"
  6. Select you bucket
  7. Click "all measurements" or what you called your table
  8. click the option / stat you want to view
  9. select the server name (should be "velocity1", if you changed it, it should be there)
  10. Press submit

Congrats, you have made your own dashboard!

Back to top