Migration guide from Version 5.7 to 5.8
5.8 does not necessarily need manual steps for update.
Standard update procedure can be used https://github.com/plan-player-analytics/Plan/wiki/How-to-update-the-plugin#how-to-update-the-plugin
5.8 removes plan_settings table from the database, which may cause older versions to fail config database storage task. This will cause an error, but the error can be ignored.
5.8 introduces data.player, data.server and data.network web permissions. They impact individual datapoints that can be viewed on the website.
These web permissions are automatically granted based on existing web permissions to retain previous functionality in 5.7:
- access.network -> group is given data.network
- access.server -> group is given data.server
- access.player -> group is given data.player
When something checks for data.player, it also checks access.player and access.player.self permissions.
This section is only relevant if you have custom software calling Plan webserver 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).
If you are using data from these, any data in them is available through /v1/datapoint in more efficient manner.
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-analytics/Plan/blob/master/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/DatapointType.java