Service Metrics: Prometheus Configuration

ESS services expose metrics in Prometheus format, which can be collected by Prometheus or any metrics collector that supports the Prometheus format. ESS-specific metrics use the prefix application_com_inrupt_, followed by a service-specific key. For example, the Query Service Indexer uses the prefix application_com_inrupt_query_fragments_ingest_.

To enable discovery and scraping by an appropriately configured metrics scraper, those ESS services that emit metrics have the following annotations in their spec:

---
spec:
  template:
    metadata:
      annotations:
        prometheus.io/port: "9000"
        prometheus.io/scheme: https
        prometheus.io/scrape: "true"
        prometheus.io/path: /q/metrics

For services with these annotations, metrics scrapers can collect metrics from the services' Kubernetes pods by making an HTTPS request on port 9000 with a path of /q/metrics.