Sending Apollo Router usage data to Apollo Studio

The Apollo Router can transmit usage data to Apollo Studio via a reporting agent called Spaceport.

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.

Enabling field-level instrumentation

Apollo field-level instrumentation (also known as FTV1 tracing) is set to a sampling rate of 0.01 by default, which means it will request traces for 1% of traffic. To change it to a higher rate, set the field_level_instrumentation_sampler value to a rate higher than 0.1. To completely disable it, set it to always_off.

The following example sets both Apollo field-level tracing and OpenTelemetry tracing to attempt to sample 50% of requests:

1
telemetry:
2
  apollo:
3
    # This example will trace half of requests. This number can't
4
    # be higher than tracing.trace_config.sampler.
5
    field_level_instrumentation_sampler: 0.5
6
  tracing:
7
    trace_config:
8
      # FTV1 uses the same trace sampling as other tracing options,
9
      # so this value must be set as well.
10
      sampler: 0.5

Note that field_level_instrumentation_sampler may not sample at a greater rate than trace_config.sampler.

Advanced configuration

send_headers

Provide this field to configure which request header names and values are included in trace data that's sent to Apollo Studio. Valid options are: only with an array, except with an array, none, all.

The default value is none, which means no header names or values are sent to Studio. This is a security measure to prevent sensitive data from leaving your infrastructure unless you specifically opt into it

send_variable_values

Provide this field to configure which variable values are included in trace data that's sent to Apollo Studio. Valid options are: only with an array, except with an array, none, all.

The default value is none, which means no variable values are sent to Studio. This is a security measure to prevent sensitive data from leaving your infrastructure unless you specifically opt into it.

1
telemetry:
2
  apollo:
3
    # The percentage of requests will include HTTP request and response headers in traces sent to Apollo Studio.
4
    # This is expensive and should be left at a low value.
5
    # This cannot be higher than tracing->trace_config->sampler
6
    field_level_instrumentation_sampler: 0.01 # (default)
7

8
    # Include HTTP request and response headers in traces sent to Apollo Studio
9
    send_headers: # other possible values are all, only (with an array), except (with an array), none (by default)
10
      except: # Send all headers except referer
11
        - referer
12

13
    # Include variable values in Apollo in traces sent to Apollo Studio
14
    send_variable_values: # other possible values are all, only (with an array), except (with an array), none (by default)
15
      except: # Send all variable values except for variable named first
16
        - first
17
  tracing:
18
    trace_config:
19
      sampler: 0.5 # The percentage of requests that will generate traces (a rate or `always_on` or `always_off`)