Collecting metrics in the Apollo Router

The Apollo Router provides built-in support for metrics collection via Prometheus and OpenTelemetry Collector.

Using Prometheus

You can use Prometheus and Grafana to collect metrics and visualize the router metrics.

router.yaml

1
telemetry:
2
  metrics:
3
    prometheus:
4
      # By setting this endpoint you enable the prometheus exporter
5
      # All our endpoints exposed by plugins are namespaced by the name of the plugin
6
      # Then to access to this prometheus endpoint, the full url path will be `/plugins/apollo.telemetry/prometheus`
7
      enabled: true

Assuming you are running locally:

Run a query against the router.
Navigate to http://localhost:4000/plugins/apollo.telemetry/prometheus to see something like:

1
# HELP http_request_duration_seconds Total number of HTTP requests made.
2
# TYPE http_request_duration_seconds histogram
3
http_request_duration_seconds_bucket{le="0.5"} 1
4
http_request_duration_seconds_bucket{le="0.9"} 1
5
---SNIP---

Note that if you have not run a query against the router you will see a blank page as no metrics will have been generated yet!

Here is the list of available metrics you'll have using Prometheus:

HTTP router request duration
HTTP request duration by subgraph
Total number of HTTP requests by HTTP Status
Total number of HTTP requests in error

Using OpenTelemetry Collector

You may send metrics to OpenTelemetry Collector for processing and eporting metrics.

router.yaml

1
telemetry:
2
  metrics:
3
    otlp:
4
      # Either 'default' or a URL
5
      endpoint: default
6

7
      # Optional protocol. Only grpc is supported currently.
8
      # Setting to http will result in configuration failure.
9
      protocol: grpc
10

11
      # Optional Grpc configuration
12
      grpc:
13
        domain_name: "my.domain"
14
        key:
15
          file: ""
16
          # env: ""
17
        ca:
18
          file: ""
19
          # env: ""
20
        cert:
21
          file: ""
22
          # env: ""
23
        metadata:
24
          foo: bar
25

26
      # Optional timeout in humatime form
27
      timeout: 2s

Edit on GitHub

Apollo Studio reporting

Tracing