Sending Apollo Router usage data to Apollo Studio

The Apollo Router can transmit usage data to Apollo Studio via a reporting agent called Spaceport. By default, Spaceport runs automatically as a component within the Apollo Router. Additional details on its modes of operation are provided below.

Enabling usage reporting

You can enable usage reporting in the Apollo Router by setting the following environment variables:

1
export APOLLO_KEY=<YOUR_GRAPH_API_KEY>
2
export APOLLO_GRAPH_REF=<YOUR_GRAPH_ID>@<VARIANT>

More information on usage reporting is available in the Studio documentation.

Advanced configuration (not recommended)

Spaceport can run either as an internal component of a single Apollo Router instance, or as an external resource shared by multiple router instances.

For the majority of users an internal Spaceport instance is sufficient.

To connect the Apollo Router to an external spaceport specify the endpoint in the config.

1
telemetry:
2
  # Optional Apollo telemetry configuration.
3
  apollo:
4

5
    # Optional external Spaceport URL.
6
    # If not specified an in-process spaceport is used.
7
    endpoint: "https://my-spaceport"

Running Spaceport externally (not recommended)

Running spaceport as a separate process currently requires building from source.