Metrics

Metrics

Prometheus

[metrics]
enabled = true
bind = "127.0.0.1"
port = 9225

The endpoint is http://<bind>:<port>/metrics. It shows players per proxy, server and client version, server status, queue lengths, logins and refused logins, connect times, kicks from backends, the network player count with sync, bot attack mode, heap, threads and uptime.

Keep bind on 127.0.0.1 or a private address. The endpoint has no password.

Grafana

Import docs/grafana/paperproxy-dashboard.json and pick your Prometheus data source.

Discord webhook

[discord]
webhook-url = "https://discord.com/api/webhooks/..."
username = "PaperProxy"
events = ["proxy", "health", "antibot", "maintenance", "update", "restart", "punish"]

Create the webhook in Discord under channel settings, Integrations, Webhooks. The URL can also be "${env:NAME}" or "file:path". The texts are in messages.yml under paperproxy.discord and can be changed or translated.

bStats

PaperProxy reports anonymous usage statistics to bStats. Turn it off in plugins/bStats/config.txt.