Plan | Player Analytics

Plan | Player Analytics 5.9 build 3867

5.9 build 3867​


This update includes a bunch of new features, security improvements, bugfixes, new APIs and more.


Special thanks to AnttiMK, DomasUrbonas, RomainCabaret, Tokas, Axionize, bobhenl & Almost10 for contributions to this update.


Breaking changes​


Java 17 or newer now required​


Plan now requires Java 17 or newer.


API is still compiled with Java 8, but that will also change to 17 in Plan version 5.10.


snake_case variables changed to camelCase in JSON endpoints​


All snake_case variables in Plan /v1/ endpoints were changed to camelCase for consistency.


Change log​


⚠ Fixed Denial of Service security vulnerability (CVSS 7.5)​


Fixed a Denial of Service vulnerability with the Jetty webserver. This affects all versions prior to this version. Updating is recommended as soon as possible, because the fixed vulnerability can be used to crash a server through memory exhaustion.


If your webserver is behind a reverse-proxy, the reverse-proxy likely mitigates the issue.


If you can not update right away, disabling the webserver temporarily with Webserver.Disable_webserver-setting until you can update also mitigates the issue.


Fabric 26.3​


  • DomasUrbonas added support for fabric 26.3, older versions are no longer supported.
  • Axionize fixed command source mixin collision with another plugin

Data gathering​


New data: Minecraft statistics​


Plan will now gather all Minecraft statistics from the player json files found in statistics folder on the game servers. They are displayed on Player, Server (sum of players) and Network pages (sum of players / server or sum of all players)

image

Kill tracking additions​


RomanCabaret implemented support for:


  • TNT explosion kills on Bukkit, Fabric and Sponge when ignited directly by a player
  • Bed and Respawn Anchor explosion kills on Bukkit, Fabric and Sponge

Bugfixes​


  • Fixed Shutdown session save sometimes storing sessions twice if server was shutdown via keyboard interrupt
  • AnttiMK Fixed Folia gathering performance data 20 times more frequently than intended.
  • Fixed Exception on Folia when setHealth(0) was called that killed the player.
  • Fixed setHealth(0) recording the death as a kill for the last player that damaged the player

Website​


  • Improved Players table loading speed (From minutes to few seconds) by removing Average ping from the table
  • Network performance graph now supports stacking on all graphs except TPS where it doesn't make sense.
    Screenshot of players online graph with stacked series
  • Converted Playerbase trends to Datapoint table (Gets individual values)
    Screenshot of Playerbase trends for 30 days
  • Playerbase Insights were incorporated into the table above
  • Converted PvpPve as Numbers table to Datapoint table (Gets individual values)
  • Almost10 implemented Query page Date-range presets
    Screenshot of two Query page presets 'Current Month' and 'Previous month'
    Screenshot of Query page preset list on Show a view
  • Made it easier to select servers on Query page
  • Almost10 implemented Timeframe presets to datapoint tables
    Screenshot of preset list
  • Fixed New Player Retention always counting 0
  • Fixed Join Address groups not being stored
  • Fixed New Player Retention help sliders not working
  • Fixed Registration erroring if same user tries to register twice before code expires

Database​


  • Fixed database transaction queue size tracking not working correctly.
  • Reduced memory impact of transaction queue

Webserver​


  • Webserver was migrated to Jetty 12 which requires Java 17. This added support for asynchronous response resolution which means more requests can be processed without waiting for previous requests to complete.
  • Deprecated /v1/playerVersus, /v1/playersOverview and /v1/network/playersOverview endpoints. Use /v1/datapoint instead.

Placeholders​


  • bobhenl reduced memory footprint of Plan Placeholders

DataExtensions​


There are some new additions to DataExtension API.


DataExtensions Graph API​


Screenshot of Vault balance over time graph



DataExtensions Statistics API​


Screenshot of Jobs statistics table


  • New API allows DataExtensions to add numeric data in table format more easily. The difference to existing API is that this allows calculating sums for these numbers across the whole server.
  • Jobs now lists job levels as Statistics
  • mcMMO now lists skill levels as Statistics

Other​


  • Plugin data cards can now be collapsed for easier viewing
    Screenshot of collapsed plugin cards
  • Different types of data inside plugin cards now layout slightly better.
  • Fixed error in extension page when rendering a number on a table
  • Fixed Booleans with 'hidden' flag appearing on the Query page

Locale​


  • Tokas updated CN and ZH_TW locales
  • AuroraLS3 updated FI locale
  • Translated missing locale keys in other locales using AI (~5000 missing translations total).

Technical​


  • Plan frontend code is now formatted with Prettier
  • Almost10 helped progress Javascript to Typescript conversion.
5.8 build 3638

This update brings some improvements and bugfixes. Next update 5.9 will require Java 17 or newer so this is released before that to get those unable to update as many fixes as possible. bStats is showing Java versions <17 at 0.6% or 35/5300 so consider updating your Java version if you're able.

Special thanks to Zoriot and Minecraft0122 for contributions to this update.

Change log
Database
  • Possibly fixed deadlock related to RemoveDuplicateUserInfoTransaction
Webserver
  • Fixed minor vulnerability where path traversal bypass allowed anyone to read .json files on the system with a tab \t or newline \n character in the file path. This is minor because filesystems often block using those characters in filenames, they are not common with .json files, and attacker would need to know the relative path to the file.
Extensions
  • Extension metadata is now cached in memory to avoid redundant database updates. Thanks to Minecraft0122 for work on this.
  • Fixed LuckPerms related exception after Plan was reloaded
Other
  • Zoriot added fabric-permissions-api as an optional dependency to fabric publish
5.8 build 3605

Special thanks to Zoriot, Minecraft0122 and OutHimic for contributions to this update

Change log
Bugfixes
  • Fixed X-Forwarded-For header being read wrong in multi-jump reverse-proxies
  • Fixed SQL syntax error related to database clean task cleaning plugin data
  • Fixed Ping graph not displaying in Server Performance graph
  • Possibly fixed 'Today' and 'Yesterday' showing wrong in frontend
Locale
  • OutHimic and Minecraft0122 updated CN and ZH_TW locales
Other
  • Zoriot fixed curseforge release pipeline
5.8 build 3579

This is a hotfix for a database clean task error


Previous change log
https://github.com/plan-player-analytics/Plan/releases/tag/5.8.3577


Migration guide from 5.7 to 5.8
https://github.com/plan-player-analytics/Plan/wiki/Migration-guide-from-Version-5.7-to-5.8

Change log
Bugfixes

  • Fixed database clean task error when there were no plugins to clean
5.8 build 3577

This update brings new features, refreshes to old features, as well as a big bunch of bugfixes and improvements.

Quick rundown of new big things includes MSPT Jitter, overhauled server performance tab with new performance metrics, overhauled session tabs, date pickers and partial dataload via datapoint endpoint.

Fabric was also updated to support minecraft 26.2 and above.

Special thanks to AnttiMK & Minecraft0122 for contributions to this update

Migration from 5.7

No manual steps are required. Older versions may fail a scheduled task due to plan_settings table removal, but that error can be safely ignored. Migration guide to 5.8

Change log
Data gathering
MSPT Jitter (new metric)

MSPT Jitter (Average, Max) is new gathered performance metric. - Jitter is calculated from difference between subsequent tick speeds (milliseconds per tick) Example: MSPT of 35, 36, 34, 80, 37 -> Jitter = 1, 2, 46, 43 -> Average=23, Max=46. Average and maximum for each minute is recorded.


High jitter indicates that tick speed varies greatly between ticks, and can be used along existing MSPT metrics to further assess how high load affects gameplay.

mspt jitter

Database (Breaking changes)

  • Removed plan_settings table (breaking) - This table facilitated serverConfiguration folder on Networks, which has now been removed. - Old versions will error upon trying to store settings. If you need to use older versions those errors can be safely ignored.
  • Added plan_incomplete_registration table - This table now allows the last step of /plan register to work on any server, when previously it only worked on the server Plan webserver was running on.
Website
New performance metrics

Performance tab was rewritten to include more interesting metrics that reflect how players and chunks impact server load. The impact of players on Entities and Chunks was also taken into account since some servers unload all chunks without players present.

There is now a help button available on the Performance as Numbers card to explain each metric.

metrics

Updated Server Performance graph

Server performance graph is now less jumpy and you can select any of the data you want to see rather than just some, using either presets on the left, or the labels at the bottom.

performance graph

New sessions tab

Sessions tab was rewritten on all pages (Network, Server, Player) and it now gets you up to 10k sessions, which can be searched further and exported as CSV. You can choose a date range using the session calendar or the new date picker component.

All of the data on session page will reflect the selected dates. All ongoing sessions within selected date range are shown, even if they didn't start within the date range, but before it.

On the Export website this feature is not available and defaults to most recent data (Similar to before)
sessions-select-date
sessions-selected-date

Other
  • The new date picker component is in use anywhere you can input dates to a text field (Query page)
  • Servers overview (Network) now loads a lot faster (It only gets the data for the server you're looking at)
  • Server overview, Network overview, Online Activity overview, Sessions and Performance tabs all got their number tables changed to get individual values independently from each other.
Bugfixes
  • Fixed some IPv6 setups being unable to login
  • Fixed Average MSPT not showing if MSPT was under 1ms
  • Fixed Hour by Hour showing Daily new players and not hourly
  • Fixed date saying 'Today' if it was in the future
  • Fixed Alternative_IP.Address changes not being reflected in Javascript due to Cache policy
  • Fixed boolean Extension values causing 'variable t not found' error.
  • Fixed component Extension values erroring
  • Fixed redirects on reverse-proxy setups with subdirectory addresses
  • Fixed value not defined error on Playerstable when showing time or date from plugin data on player table
  • Fixed stacked players online graph not stacking
  • Fixed Players Online tooltip going under table headers
Fabric 26.2
  • Updated to Fabric 26.2 which required no API changes.
  • AnttiMK implemented Fabric 26.1 support. 1.21.9-1.21.11 are no longer supported by this version.
Settings
  • serverConfiguration folder and related config sync features have been removed on Networks.
  • Display_options.Sessions.Show_on_page setting has been removed
  • Changed default value for Time.Thresholds.Remove_time_series_after to 3650 on Bungee/Velocity (Default is not automatically replaced)
Locale
  • CN locale updated by Minecraft0122
Extensions
  • Fixed error related to Folia and CMI extension
  • Fixed error related to deleting disabled extension data
Placeholders
  • Fixed error on top list placeholders for playtime or kill count
Other
  • Added database transaction queue information to /plan info command
  • Fixed deadlock related to ban status update task
  • Fixed /plan db uninstalled printing "success" before completing properly
  • AnttiMK updated Java compile options so that test code can use features from newer JDKs
  • Optimized Playerbase development graph generation query
  • Optimized Players online peak query
  • Possibly fixed TPSTableIdPatch failing on SQLite due to table lock
Webserver: /v1/datapoint

To implement dynamic date based filtering, new endpoint /v1/datapoint was implemented. It makes implementing new single-value metrics a lot easier, since it's possible to produce tables of metrics by just defining a column 'time slot' and each row as a metric - you can already see impacts with the new metrics that were already added. This endpoint will be further expanded upon in the future.

This endpoint takes in after/afterMillisAgo, before/beforeMillisAgo and server or player parameters. server parameter can take in multiple server uuids comma separated. The endpoint returns 200, 302 (cached by browser) or 400 (invalid type). Please use ETag for caching if calling this endpoint from program code.

Example /v1/datapoint?type=PLAYTIME&afterMillisAgo=86400000&server=uuid will get you playtime for last 24h on a server.

All the supported datapoint types can be found from https://github.com/plan-player-anal...y/rendering/json/datapoint/DatapointType.java

Deprecated endpoints

Following endpoints are deprecated in favor of the new /v1/datapoint endpoint:
  • /v1/serverOverview
  • /v1/network/overview
  • /v1/network/servers
  • /v1/onlineOverview
  • /v1/sessionOverview
  • /v1/performanceOverview
  • /v1/network/performanceOverview

Accessing the deprecated endpoints will print a warning on the console (Due to performance impact).

New Web permissions

/v1/datapoint uses new web permissions data.player, data.server, data.network (and further subdivisions) to control visiblity. These permissions are granted automatically based on existing permissions:
  • access.network -> group is given data.network
  • access.server -> group is given data.server
  • access.player -> group is given data.player
/v1/datapoint will also check for access.player and access.player.self if looking for player specific data.
5.7 build 3306

Hotfix for config update bug in build 3288.

Change log
  • Fixed config resetting some values to default on reload
  • Fixed table sorting with alphabetical things
  • Minor dependency updates
  • CI pipelines for releasing to Ore, Hangar and Modrinth
5.7 build 3288

This release contains bugfixes to build 3265 and a new theme.

Special thanks to Kopo, Leolebleis & Guinness_Akihiko for contributions to this update

Change log
Website
  • Improved readability of World Pie on servers that have over 7 worlds
  • Improved readability of Server Pie on networks that have over 7 servers
  • Moved Performance graph loading to Web Worker (async threading in browsers) - This should improve rendering times slightly
  • Fixed issue where Join Address Groups would reset when using HTTPS
  • Fixed a couple of instances where Trend was not properly showing
  • Fixed 'showPlayersOnline is not defined' when viewing network page on networks with multiple Proxy servers
  • Fixed a bug with Change history floating on top of the Save button in Theme Editor when using Night mode.
  • Fixed CUSTOM locale defaulting to Chinese locale for time/date/country localization due to "Best match" in browser matching.
  • Fixed Swagger documentation not showing
  • Fixed 'New player retention' label in Server overview
  • Fixed typo in a locale key
  • Fixed Low TPS Insights showing entities instead of CPU
  • Leolebleis fixed reverse-proxy https address not being recognized as correct address
Fabric

Kopo updated Fabric to use Mojang mappings (Tested with 1.12.9-1.12.11)

Themes

Added solarized theme based on https://github.com/altercation/solarized

solarized theme
Config
  • Possibly fixed a race condition that caused server identity to be reset, creating duplicate servers when server was shut down during Database patching
  • Fixed trailing comments removing part of config setting value.
  • Fixed some config changes being applied every time
Locale
  • Guinness_Akihiko updated KO locale
Other
  • Builds now require JDK 25 for switch to Mojang mappings.
5.7 build 3247

This update brings a big bunch of new features and improvements, such as Theme Editor, Milliseconds per Tick, Players online -tooltip, Database move/merge rewrite and many others.


Special thanks to Kopo, SaolGhra, TWJohnJohn20116, Shadowhackercz, Vankka, DrexHD, Jsinco & julianvdhogen for contributions to this update

Change log

The theme settings have changed.
See https://github.com/plan-player-analytics/Plan/wiki/Migration-guide-from-Version-5.6-to-5.7 for what might need changing in the config.

Website
Fixed vulnerabilities

  • Fixed potential XSS injected through malicious plugin. (User would have had to click the link to activate XSS) What is XSS
  • Fixed potential Session hijack vulnerability after successful XSS where attacker could read authentication cookie through javascript.
    • It is recommended to run /plan logout * after the update to protect against this vulnerability, even if the sessions will eventually expire.

There has not been reports of exploitation of these vulnerabilities.

Theme Editor

You can now create your own themes for Plan without needing Html Customization. This is the main new feature of this version and is documented here.

image
  • theme.yml has now been deprecated and will be deleted if it only contains default values
MSPT (Milliseconds per Tick)
image
Milliseconds per Tick (average/95th percentile) have been added to performance metrics on all applicable platforms.

Players online -tooltip
image
You can now hover over Players online graph to see who was online at specific time (up to 63 players).

Query page improvements
image
  • New filters have been added
    • Played on date
    • Activity group on date
    • Last seen between
  • All 'between' filters now support 'Before' and 'After' by deselecting one of the checkboxes (e.g. played between -> played before)
  • Multi-select components have been replaced with a mobile friendly, text searchable alternative that no longer requires pressing Shift for multi-selection
  • Fixed timezone inconsistency between View time input fields and the graph
Performance graph improvements

performance-tab-graph-linking


  • Performance graph tabs now sync the graph range-finder so that you can view different data for same time easier
  • Network performance graph colors now vary between servers to be easier to read
  • Fixed extra Series label appearing in HTTP mode on Performance graph (This was the plugin version history series in HTTPS mode)
  • Added Uptime data to Performance as Numbers tables
Other

  • Kills table can now be searched/sorted/exported and gets up to 25000 entries from the database
image
  • Added support for nickname search in player tables
  • Fixed some night mode text invisibility issues
  • SaolGhra fixed error r.includes is not a function related to Litebans
  • Fixed 'View full query' button in the modal that opens when clicking Server calendar
  • Fixed clicking Server calendar results including players who played on other servers during selected days
Config

  • Changed default Display_options.Player_head_image_url to https://crafthead.net/helm/${playerUUIDNoDash}/120 (Existing configs need to be manually updated)
  • Jsinco updated 'Data_gathering.Join_addresses_.Filter_out_from_data' to support regex. Note that any existing setting values with . (dot character) will now match any character.
  • Display_options.Theme (default "default") now refers to theme name in the theme editor rather than "What theme.yml to copy values from"
  • Display_options.Night_mode (default false) added
Data

  • MSPT average and 95th percentile added to plan_tps table
  • Register date 0 (1970-01-01) is now regarded as invalid.
  • Ban status is now updated by an automatic task that cycles through all known players small amount at a time
Sponge

  • Sponge API 14 is now used, API 8 is no longer supported.
Fabric

  • Fabric was updated to 1.12.9 by DrexHD (Supports 1.12.11 as well)
Velocity

  • Velocity was updated to 3.5.0-SNAPSHOT
Database
Database move system rewrite

Rewrote the system responsible for copying data from one database to another since previous system would crash under large datasets. The goal of this was to allow copying large SQLite databases to MySQL even on larger servers. The system was tested against a 3 GB MySQL database on a server with 1 GB of allocated memory. (Sidenote: Please don't try to run your server off 3 GB large database.db SQLite file)


  • /plan db move, /plan db backup, /plan db restore use the new system
  • Added /plan db merge command (permission: plan.data.merge) which allows merging SQLite data to existing MySQL. This is useful for those merging multiple servers into a network when all servers had Plan installed on separate SQLite databases.
Other

  • id column added to old plan_tps tables that did not have it yet via Patch.
  • Lock hints for selections inside transactions to reduce deadlocks
  • Fixed 1020 "Record has changed since last read in table" error on MariaDB 11.8.3
  • Fixed dyplicate key violation related to AllowListBounce
  • Possibly fixed ShutdownDataPreservationTransaction failing on existing join address insert
  • Fixed playtime queries where session started before view window or ended after.
Locale

  • Dates, time amounts & country names are now translated based on the selected locale. (If specific ones aren't please report it as a bug)
  • HighCharts & Calendar are now translated based on the selected locale
  • TWJohnJohn20116 updated zh_TW locale
  • Shadowhackercz updated CS locale
  • julianvdhogen updated NL locale
Extensions

  • Fixed ArithmeticException related to LibertyBans when bans were infinite
  • Fixed an issue related to rendering boolean values
  • Updated Jobs extension to support newer version
  • Added Time.Periodical_tasks.Extension_player_data_refresh_every setting (default 15 MINUTES) which only affects plugins that decide to support it.
  • Made gathered PlaceholderAPI data update periodically
Placeholders

  • Fixed network_players_online always saying 0
Other

  • Added Typescript support.
  • Vankka updated DependencyDownload to clean up libraries folder of old versions
  • Kopo updated the build system to speed up builds & IDE indexing performance
5.6 build 2965
This build has a second hotfix for SQLite performance regression since it was reverted to wrong version that still had the regression.
Please see https://github.com/plan-player-analytics/Plan/releases/tag/5.6.2959 for change log of the previous version.
Change log
  • Reverted SQLite driver to version 3.42.0.1 due to performance regression (Thanks to Vankka for pointing out my mistake)
5.6 build 2961
This build has a hotfix for SQLite performance regression.
Please see https://github.com/plan-player-analytics/Plan/releases/tag/5.6.2959 for change log of the previous version.
Change log
  • Reverted SQLite driver to version 3.45.1.0 due to performance regression
Back
Top