Skip to content

Observability tap

The observability tap gives you direct, read-only access to the Prometheus-compatible metrics API and the Loki-compatible logs API for your GameFabric installation. Use it to view this data in your own observability tools that support these APIs.

Requesting access

Access to the observability tap is not enabled by default. To request it, contact your Customer Success Manager or raise a request through the GameFabric Help Center. Once approved, your Customer Success Manager provides the Bearer token needed to authenticate against the endpoints.

Endpoints

All observability tap endpoints are available under your installation's base URL:

https://<your-installation>.gamefabric.dev/observability/

Replace <your-installation> with your installation name.

The two sub-paths expose the respective APIs:

APIBase URL
Prometheus-compatible metricshttps://<your-installation>.gamefabric.dev/observability/metrics/
Loki-compatible logshttps://<your-installation>.gamefabric.dev/observability/logs/

Authentication

All requests to the observability tap must include a Bearer token in the Authorization header:

http
Authorization: Bearer <token>

You receive this token when access is granted. Include it with every request, regardless of which tool or client you use.

Querying metrics

The metrics endpoint is compatible with the PromQL query language. Any tool that supports PromQL also works against this endpoint.

The following Prometheus HTTP API paths are available:

  • /observability/metrics/api/v1/query — instant query
  • /observability/metrics/api/v1/query_range — range query
  • /observability/metrics/api/v1/series — series metadata
  • /observability/metrics/api/v1/labels — label names
  • /observability/metrics/api/v1/label/<label_name>/values — label values
  • /observability/metrics/api/v1/metadata — metric metadata
  • /observability/metrics/api/v1/status/buildinfo — build information

Refer to the Prometheus query documentation for the full query language reference.

Querying logs

The logs endpoint is compatible with the Loki LogQL query language.

The following Loki HTTP API paths are available:

  • /observability/logs/loki/api/v1/query — instant query
  • /observability/logs/loki/api/v1/query_range — range query
  • /observability/logs/loki/api/v1/labels — label names
  • /observability/logs/loki/api/v1/label/<label_name>/values — label values
  • /observability/logs/loki/api/v1/series — series metadata
  • /observability/logs/loki/api/v1/index/stats — index statistics
  • /observability/logs/loki/api/v1/tail — live tail
  • /observability/logs/loki/api/v1/status/buildinfo — build information

Refer to the Loki LogQL reference for the full query language documentation.

Connecting to the observability tap from your own observability tool

Grafana

You can add both endpoints as data sources in your own Grafana instance.

Metrics data source

  1. In Grafana, go to Connections > Data sources and select Add new data source.
  2. Choose Prometheus as the data source type.
  3. Set the URL to https://<your-installation>.gamefabric.dev/observability/metrics/.
  4. Under Authentication, set the Authentication method to No authentication.
  5. Under HTTP headers, click Add header and set Header to Authorization and Value to Bearer <token>. Replace <token> with the token you receive from your Customer Success Manager. Keep the Bearer prefix.
  6. Select Save & test to verify the connection.

Logs data source

  1. In Grafana, go to Connections > Data sources and select Add new data source.
  2. Choose Loki as the data source type.
  3. Set the URL to https://<your-installation>.gamefabric.dev/observability/logs/.
  4. Under Authentication, set the Authentication method to No authentication.
  5. Under HTTP headers, click Add header and set Header to Authorization and Value to Bearer <token>. Replace <token> with the token you receive from your Customer Success Manager. Keep the Bearer prefix.
  6. Select Save & test to verify the connection.

Once the data sources are configured, you can build dashboards and alerts in your own Grafana instance using the same metrics and logs that power the built-in GameFabric monitoring dashboards.