LuckPerms
collector-luckperms · version 0.6.1 · registers as luckperms · CI 2026-09-25
The LuckPerms collector.
Backgrounded, for a single metric: getUniqueUsers() scans the whole user table. Groups are already in memory and cost nothing — but splitting would mean two collectors for one subject, and being five minutes behind on an account count never changed a decision.
Group membership only counts online players, and that's deliberate: the API has no way to count a group's members without loading every user, one by one, from the database. The overall count is a single SQL query on luckperms_user_permissions — that's the sql module's job, not this one's.
Install
Put vania-metrics-collector-luckperms-0.6.1.jar in the plugins folder, next to the core and to LuckPerms, then restart. The collector depends on both: without LuckPerms it stays disabled, and the core keeps running.
- Target plugin: LuckPerms 5.5.71 — latest for Minecraft 1.21.11: 5.5.71
- Built against: core v0.6.0
- Download: vania-metrics-collector-luckperms-0.6.1.jar, with its SHA-512, from the v0.6.1 release
- Collects: in the background, every 300 s — reading the plugin's state never blocks a scrape
- Tested on: Java 21
- Latest CI: success · 2026-09-25 21:29 UTC · commit
b12741a· run
Platforms
| Platform | Target plugin | Collector | Latest CI |
|---|---|---|---|
| Paper | yes | Passed | paper ✓ |
| Purpur | yes | Passed | purpur ✓ |
| Folia | yes | Passed | folia ✓ |
| Spigot | yes | Passed | spigot ✓ |
| CraftBukkit | yes | Passed | bukkit ✓ |
| Sponge | yes | Not yet | — |
| Velocity | yes | Passed | velocity-3.5.1 ✓ · velocity-4.2.1 ✓ |
| BungeeCord | yes | Passed | bungeecord ✓ |
| Waterfall | yes | Passed | waterfall ✓ |
| Geyser | unknown | Unknown | — |
See the compatibility matrix for every collector at once.
Metrics
mc_permission_group_weight
gauge group
A group's weight, as LuckPerms uses it to resolve conflicts.
mc_permission_groups
gauge
Declared groups.
mc_permission_online_by_group
gauge group
Players ONLINE by primary group. For the offline total, see the sql module — the API can't count without loading everything.
mc_permission_tracks
gauge
Declared promotion tracks.
mc_permission_users
gauge
Users known to LuckPerms. Scans the table: collected in the background.
Configuration
In metrics.properties, or as environment variables. See Configuration.
| Key | Default | Environment variable |
|---|---|---|
collector.luckperms | true | VANIA_METRICS_COLLECTOR_LUCKPERMS |
collector.luckperms.interval | 300 | VANIA_METRICS_COLLECTOR_LUCKPERMS_INTERVAL |