Monitoring

API port

The API port is by default 32004 or 64001 depending on if the replication server is running in world or rooms mode. All access to the API with the exception of the /health endpoint require an authorization token in the format "Authorization: Bearer SECRET" where SECRET is the same secret used in the --secret parameter when launching the replication server.

• Health check - the /health API endpoint returns the health status of the replication server. No auth token required.

• Basic status - the /status API endpoint returns information about the total number of connections and memory stats.

• Golang pprof stats - the /debug/pprof/* endpoints are available for deeper monitoring and profiling of the active replication server.

Stats port

The stats port is by default 32000 or 64000 depending on if the application is running in world or rooms mode. This endpoint does not require an authorization token.

• Prometheus Metrics - the /metrics endpoint returns scraped prometheus metrics.