How to Retrieve and Read Timings Report

_Tarna_ · December 2, 2020

M I N E H U T C O M M U N I T Y F A Q

HOW TO READ AND RETRIEVE TIMINGS

DIFFICULTY: MEDIUM

Introduction to Timings:

Timings measures how well your server is processing everything. If your server is lagging, timings one of the best ways to figure out why and what is causing it.

Retrieving the Timings Report:

Timings automatically are enabled on the server when it starts. So you can do /timings paste to retrieve the timings link. The link displays a lot of information about the server in a graphical format.

How to read the Timings Report:

The timings report is separated into multiple sections. Some of the sections will show information about each plugin on the server, if you have any, and the rest are Minecraft’s own tick events.

At the top of the report, there are a few data points that each show general information.

Total: the total time spent handling events.
Sample Time: The total time the server has been collecting timings data for the report.
Average Entities: The average number of activated entities, followed by the average number of total entities.
Average Players: The average amount of players logged in during the sample time.
Average TPS: The average server tick rate during the sample time.

In the headers part of the plugins section, there are 2 data points showing the name and version.

Total: The total time spent by the plugin processing events during the sample time.
Pct: The percentage of the sample time this represents.

Each section also has multiple columns of data for each event a plugin handles.

Pct Total: The percentage of the total sample time spent processing the event.
Pct Tick: The percentage of a single tick (50 ms) spent processing the event.
Total: The total time spent during the sample time.
Avg: The average amount of time spent per tick.
Count: The amount of times the event was fired and handled by the plugin.
Vio: The percentage of the total violation count this plugin was responsible for.
Event: The name of the event.

Identifying Lag:

Any percentages in the timings that are red are potential sources of lag. The things that may be causing most of the lag on the server are listed at the very top of the timings.

The pct total (percentages) in the timings are a good indicator to see what's causing the lag on your server. If a certain event or plugin takes up a large percentage or a large amount of time to process, it could be responsible for the lag on the server.

The pct tick column is also useful for identifying the cause of the lag on the server. An example is if your players are complaining about lag when they join the server, checking the PlayerJoinEvent in the timings could help. Seeing a large number in the Pct Tick column and a low number in the Count column could show that the plugin is spending a lot of a single tick processing the event, and thus causing a lag spike.

Require further assistance?:

If you are confused about what may be the cause of lag, head over to this section of forums, or join our Discord and ask for help there. Make sure to include the link to your timings report.

https://www.spigotmc.org/wiki/timings/

Compiled by the Minehut Staff Team

Edited December 2, 2020 by _Tarna_
fixed formatting