Wiki Release: 2026.09.8 · UltimateClans: 9.1.4 · Documentation branch: 9 · Logger
Logger#
Logger adds persistent clan activity logging with GUI/query management, storage and placeholders. The pages in this section explain what players see in-game, what administrators need to configure, the normal setup flow, and the most common problems you may need to diagnose.
Compatibility#
- Component version:
1.2 - Documentation release:
2026.09.8 - Minimum UltimateClans version:
9.0.0
What you can do with it#
- Enable the logger categories you need
- Perform a test clan action and open/query the clan log
- Configure retention/limits so the log remains useful without unlimited growth
How it works#
Audit log model#
Logger records selected clan events with timestamps and presents them through command/GUI queries. Config.Logger.events selects what should be stored; expiry controls retention; the Storage section chooses SQLite/MySQL. On a network, use a shared backend if staff must see the same history from every server.
First setup#
Before enabling the feature for players, review these installed files:
commands.ymlconfig.ymlgui.ymllanguage/Lang_EN.ymllanguage/Lang_ES.yml
Recommended in-game workflow#
- Enable the logger categories you need.
- Perform a test clan action and open/query the clan log.
- Configure retention/limits so the log remains useful without unlimited growth.
This feature is mainly automatic or accessed through the parent plugin/GUI, so it does not need a large standalone command tree.
GUI areas#
The installed GUI configuration contains screens/sections such as:
General.clan_loggerGeneral.clear_logger_confirm
What administrators should configure#
- Use MySQL when logs need to be shared across multiple servers; keep schema/database settings identical.
Configuration map#
config.yml—Config(date_format_short, timezone, Logger, Icon, Permissions);Storage(type, mysql, user, pass, databases, datasource)
The Configuration page lists the available paths and defaults from the installed configuration, with notes on what each area controls.
Before going live#
- Back up the component data/configuration.
- Start the server and confirm the component is detected without startup errors.
- Test with a non-OP player and the lowest clan role that should have access.
- Exercise the complete flow once, including the failure/deny path, not only the happy path.
- Restart the server and verify that persistent state survives.
- If the network is multiserver, repeat the test from a second node and verify storage/synchronization.
Troubleshooting quick reference#
| Symptom | Likely cause | What to check |
|---|---|---|
| No log entry | Event/category disabled or persistence failed | Check logger category and storage error. |
| GUI is empty but database has rows | Query filters/clan ID/cache mismatch | Check clan identifier and reload query. |
| Log grows too large | Retention/cleanup not configured | Set a sensible limit/cleanup policy. |
For a longer diagnostic flow, open the Troubleshooting page for this component.