Setting up Minecraft TPS/MSPT monitoring

What is Minecraft TPS/MSPT monitoring?

Minecraft TPS (Ticks per Second) or MSPT (Milliseconds per Tick) is a monitoring service which checks your Minecraft server's TPS or MSPT at regular interval. TPS and MSPT are metrics which showcase how your Minecraft server is performing.

For TPS, the closer it is to 20, the better. For MSPT the lower it is, the better. 

With MSPT monitoring we collect your server's minimum, average and maximum MSPT from the last minute. Degraded performance is declared based on the average MSPT value if it meets the threshold set by you.

Setting up Minecraft TPS/MSPT monitoring

First time setup:

Quick overview: Download plugin > Install plugin on Minecraft server > Register account at StatusMC > Create statuspage (only necessary on first time setup) > Create monitor > Paste details to plugin config > Restart server

Route overview: Log in > Account dashboard > Statuspage dashboard > Monitoring > + New Monitor

1. Download the plugin from StatusMC's Downloads page.

2. Install the plugin on your  server by placing the jar file in the "plugins" folder and restarting the server.

3. Create an account on StatusMC here and verify your email address.

4. Create a statuspage to be able to access all of StatusMC's features, such as monitoring and incident management.

5. Navigate to the "Monitoring" page from the sidebar and click the "+ New Monitor" button.

6. Choose Minecraft TPS or Minecraft MSPT from the Monitor type dropdown.

7. You will now be presented with the following options:

• Check Frequency: how often we check your server's TPS/MSPT (either every minute or every 5 minutes). Every minute monitoring is only available on the Startup plan.
• Server Name: this has no effect on monitoring, this is just for your reference.
• Server IP: the IP address that is used to connect to your Minecraft server. It is recommended to use a numeric IP address here.
• StatusMC port: the port that we use to connect to your Minecraft server, this cannot be the same as the port that players use to connect to your server. 
• Secret Key: a random key that is used for security reasons when connecting to your server, think of this as like a password. Do not publicly share this secret key.
• When do we notify you?: A threshold from which on we will take action.
• What to do when MSPT is equal to or higher than your set threshold?:
  • Mark service status as Degraded Performance: marks the related service's status as Degraded Performance.
  • Create an Incident: creates an incident, either based off of a template specified by you or a system generated message.
  • Send an E-mail: sends an email
  • Call a Webhook: calls a webhook, you're responsible for coding your own webhook.

8. Once you have filled in all of the necessary data, click "Create Monitor" to create your new monitor.

9. On your Minecraft server navigate to the StatusMC plugin's config file, located at "/plugins/StatusMC/config.yml"

• In the config file, paste the secret key that you generated previously in the dashboard into the "secret_key" field in the plugin's config file. Next, enter the port which you chose to use previously in the dashboard into the "port" field in the config file.

10. Restart your Minecraft server and you're all good to go!