Monitoring

WorldAPI already holds what a monitoring stack wants: TPS, tick times, memory, worlds, players, and their statistics. Two companion projects turn that into graphs, and Plan shows WorldAPI's own state.

Prometheus and Grafana

1. Run minecraft-exporter next to Prometheus and point it at WorldAPI:

   services:
     minecraft-exporter:
       image: ghcr.io/mairwunnx/minecraft-exporter:latest
       restart: unless-stopped
       environment:
         WORLDAPI_URL: http://minecraft:8110/api/v1

2. Let Prometheus scrape minecraft-exporter:10059.

3. Import the WorldAPI dashboard into Grafana: it's 25941 on grafana.com.

Out of the box WorldAPI lets visitors read everything the exporter needs, so a token is optional. A token opens more: the host's load, the console's warnings, what crowds each world. Give it a group with read permissions only, never one that writes. The exporter's README lists its settings and what each permission adds.

Plan

With Plan installed, WorldAPI adds its own section to Plan's pages. Nothing to configure.

• The server page shows the version, the number of endpoints, the WebSocket clients connected now, the active tokens, and the events in history.
• A player's page shows the tokens they made in game, with each one's permissions and expiry. A column in the players table counts them.

Token values never reach Plan.

Health in one request

GET /api/v1/server carries the version, the players online, TPS, MSPT, memory, loaded chunks, and entities. A status page or an uptime checker needs nothing else. See Server.

Next: MCP.