Skip to content

Server Monitor Plugin

Plugin

This feature is provided by the Empostor.Plugins.Monitor plugin (gg.empostor.monitor). It must be installed and enabled for this to work.

Overview

The Server Monitor plugin provides HTTP API endpoints for monitoring server health and status. These endpoints are useful for external monitoring tools, load balancers, and custom dashboards.

Endpoints

GET /api/monitor/status

Returns detailed server status including uptime, resource usage, and active games.

Response:

json
{
  "status": "running",
  "timestamp": "2026-05-23T12:00:00.0000000Z",
  "uptime_seconds": 86400,
  "uptime_display": "1d 0h 0m",
  "version": "1.0.0",
  "runtime": ".NET 8.0.0",
  "platform": "Linux 5.15.0",
  "processors": 4,
  "memory_mb": 256,
  "game_count": 3,
  "player_count": 22,
  "active_connections": 30,
  "games": [
    {
      "code": "ABCDEF",
      "state": "Started",
      "map": "Skeld",
      "player_count": 10,
      "host": "PlayerName"
    }
  ]
}
FieldTypeDescription
statusstringAlways "running" when server is healthy
timestampstringISO 8601 UTC timestamp
uptime_secondsnumberSeconds since server process started
uptime_displaystringHuman-readable uptime
versionstringServer version
runtimestring.NET runtime description
platformstringOS description
processorsnumberCPU core count
memory_mbnumberWorking set memory in MB
game_countnumberTotal active games
player_countnumberPlayers currently in games
active_connectionsnumberTotal active connections
gamesarrayActive game details

GET /api/monitor/health

Simple health check for load balancers and monitoring tools.

Response:

json
{
  "status": "healthy",
  "timestamp": "2026-05-23T12:00:00.0000000Z"
}

Returns HTTP 200 when the server is healthy.

Configuration

This plugin requires no configuration.