Metric exporting (add-on)
Metric exporting provides a Prometheus-conforming endpoint for scraping application performance metrics from your Nakama instances.
Overview #
You receive a dedicated URL behind a username and password. The endpoint produces Prometheus-conforming metrics that you scrape every minute. Plot the data in Grafana or any tool of your choice outside of Heroic Cloud.
Included metrics #
The endpoint includes the following categories of metrics:
- All Nakama application metrics—the full set of internal metrics emitted by the Nakama server, including session counts, storage operations, matchmaker queue stats, runtime function execution, and Go runtime metrics.
- Load balancer metrics—error rates, requests per second, and HTTP response class counts (2xx, 3xx, 4xx, 5xx).
- Custom metrics—any metrics you emit through your own game module code also appear on the same endpoint.
Database metrics aren’t exposed through the metric export endpoint.
Alerting #
Set up alerting based on these metrics within your own system. Configure all alerting in your own tooling (for example, Grafana, PagerDuty). Heroic Cloud exports the raw metrics only.
Enabling metric exporting #
Contact Heroic Labs (support@heroiclabs.com) to enable this add-on. Self-service UI support is planned.
Metric exporting is a separate, paid add-on to your Heroic Cloud subscription.
