Apollo Router

The socket address and port to listen on Defaults to 127.0.0.1:8088

Set to false to disable the health check

Optionally set a custom healthcheck path Defaults to /health

Optionally specify readiness configuration

The readiness interval configuration

How many rejections are allowed in an interval (default: 100) If this number is exceeded, the router will start to report unready.

The sampling interval (default: 5s)

The unready interval (default: 2 * sampling interval)

Set to true to enable sandbox

Set to false to disable the homepage

Graph reference This will allow you to redirect from the Apollo Router landing page back to Apollo Studio Explorer

The server http configuration

Header read timeout in human-readable format; defaults to 10s

The socket address and port to listen on Defaults to 127.0.0.1:4000

The timeout for shutting down connections during a router shutdown or a schema reload.

The HTTP path on which GraphQL requests will be served. default: "/"

Enable introspection Default: false

Enable QP generation of fragments for subgraph requests Default: true

Set to false to disable defer support

Query planning options

abort request handling when the client drops the connection. Default: false. When set to true, some parts of the request pipeline like telemetry will not work properly, but request handling will stop immediately when the client connection is closed.

Enable errors generated during response reformatting and result coercion to be returned in responses. Default: false All subgraph responses are checked and corrected to ensure alignment with the schema and query. When enabled, misaligned values will generate errors which are included in errors array in the response.

Log a message if the client closes the connection before the response is sent. Default: false.

Cache configuration

Warms up the cache on reloads by running the query plan over a list of the most used queries (from the in memory cache) Configures the number of queries warmed up. Defaults to 1/3 of the in memory cache

Sets a limit to the number of generated query plans. The planning process generates many different query plans as it explores the graph, and the list can grow large. By using this limit, we prevent that growth and still get a valid query plan, but it may not be the optimal one.

The default limit is set to 10000, but it may change in the future

Before creating query plans, for each path of fields in the query we compute all the possible options to traverse that path via the subgraphs. Multiple options can arise because fields in the path can be provided by multiple subgraphs, and abstract types (i.e. unions and interfaces) returned by fields sometimes require the query planner to traverse through each constituent object type. The number of options generated in this computation can grow large if the schema or query are sufficiently complex, and that will increase the time spent planning.

This config allows specifying a per-path limit to the number of options considered. If any path's options exceeds this limit, query planning will abort and the operation will fail.

The default value is None, which specifies no limit.

If cache warm up is configured, this will allow the router to keep a query plan created with the old schema, if it determines that the schema update does not affect the corresponding query

Configures cooperative cancellation of query planning

See [CooperativeCancellation] for more details.

Configures the in memory cache (always active)

Configures and activates the Redis cache

Number of entries in the Least Recently Used cache

List of URLs to the Redis cluster

Redis username if not provided in the URLs. This field takes precedence over the username in the URL

Redis password if not provided in the URLs. This field takes precedence over the password in the URL

Redis request timeout (default: 500ms)

TTL for entries

namespace used to prefix Redis keys

TLS client configuration

Prevents the router from starting if it cannot connect to Redis

When a TTL is set on a key, reset it when reading the data from that key

The size of the Redis connection pool

list of certificate authorities in PEM format

client certificate authentication

list of certificates in PEM format

key in PEM format

When true, cooperative cancellation is enabled.

When enabled, this sets whether the router will cancel query planning or merely emit a metric when it would have happened.

Enable timeout for query planning.

Set to true to allow any origin. Defaults to false. This is the only way to allow Origin: null.

Set to true to add the Access-Control-Allow-Credentials header.

The headers to allow.

If this value is not set, the router will mirror client's Access-Control-Request-Headers.

Note that if you set headers here, you also want to have a look at your CSRF plugins configuration, and make sure you either:

• accept x-apollo-operation-name AND / OR apollo-require-preflight
• defined csrf required headers in your yml configuration, as shown in the examples/cors-and-csrf/custom-headers.router.yaml files.

Which response headers should be made available to scripts running in the browser, in response to a cross-origin request.

Allowed request methods. See module documentation for default behavior.

The Access-Control-Max-Age header value in time units

The origin(s) to allow requests from. The router matches request origins against policies in order, first by exact match, then by regex. See module documentation for default behavior.

Set to true to add the Access-Control-Allow-Credentials header for these origins

The headers to allow for these origins

Which response headers should be made available to scripts running in the browser

Regex patterns to match origins against.

The Access-Control-Max-Age header value in time units

Allowed request methods for these origins.

The origins to allow requests from.

When Some, the Access-Control-Allow-Private-Network header will be added as well as the respective headers contained within the policy.

When specified, the Private-Network-Access-ID header will be added with the given ID. The ID must be a 48-bit value presented as 6 hexadecimal bytes separated by colons, e.g. 01:23:45:67:89:0A.

When Some, the Private-Network-Access-Name header will be added with the given name. The name can be at most 248 UTF-8 code units and match a RegEx equivalent to the ECMAScript RegEx /^[a-z0-9_-.]+$/.

TLS server configuration

This will affect the GraphQL endpoint and any other endpoint targeting the same listen address.

Outgoing TLS configuration to subgraphs.

Outgoing TLS configuration to Apollo Connectors.

server certificate in PEM format

server key in PEM format

list of certificate authorities in PEM format

options applying to all subgraphs

per subgraph options

Map of subgraph_name.connector_source_name to configuration

Options applying to all sources

Activates Automatic Persisted Queries (enabled by default)

Configures the in memory cache (always active)

Configures and activates the Redis cache

List of URLs to the Redis cluster

Redis username if not provided in the URLs. This field takes precedence over the username in the URL

Redis password if not provided in the URLs. This field takes precedence over the password in the URL

Redis request timeout (default: 500ms)

TTL for entries

namespace used to prefix Redis keys

TLS client configuration

Prevents the router from starting if it cannot connect to Redis

When a TTL is set on a key, reset it when reading the data from that key

The size of the Redis connection pool

Interval for collecting Redis metrics (default: 1s)

options applying to all subgraphs

per subgraph options

Enable

Activates Persisted Queries (disabled by default)

Enabling this field configures the router to log any freeform GraphQL request that is not in the persisted query list

Restricts execution of operations that are not found in the Persisted Query List

Experimental feature to prewarm the query plan cache with persisted queries

Enables using a local copy of the persisted query manifest to safelist operations

Enables hot reloading of the local persisted query manifests

Enables using the persisted query list as a safelist (disabled by default)

Enabling this field configures the router to reject any request that does not include the persisted query ID

Enabling this field uses the persisted query list to pre-warm the query planner cache on startup (disabled by default)

Enabling this field uses the persisted query list to pre-warm the query planner cache on schema and config changes (enabled by default)

If set, requests with operations deeper than this maximum are rejected with a HTTP 400 Bad Request response and GraphQL error with "extensions": {"code": "MAX_DEPTH_LIMIT"}

Counts depth of an operation, looking at its selection sets,˛ including fields in fragments and inline fragments. The following example has a depth of 3.

query getProduct {
  book { # 1
    ...bookDetails
  }
}

fragment bookDetails on Book {
  details { # 2
    ... on ProductDetailsBook {
      country # 3
    }
  }
}

If set, requests with operations higher than this maximum are rejected with a HTTP 400 Bad Request response and GraphQL error with "extensions": {"code": "MAX_DEPTH_LIMIT"}

Height is based on simple merging of fields using the same name or alias, but only within the same selection set. For example name here is only counted once and the query has height 3, not 4:

query {
    name { first }
    name { last }
}

This may change in a future version of Apollo Router to do full field merging across fragments instead.

If set, requests with operations with more root fields than this maximum are rejected with a HTTP 400 Bad Request response and GraphQL error with "extensions": {"code": "MAX_ROOT_FIELDS_LIMIT"}

This limit counts only the top level fields in a selection set, including fragments and inline fragments.

If set, requests with operations with more aliases than this maximum are rejected with a HTTP 400 Bad Request response and GraphQL error with "extensions": {"code": "MAX_ALIASES_LIMIT"}

If set to true (which is the default is dev mode), requests that exceed a max_* limit are not rejected. Instead they are executed normally, and a warning is logged.

Limit recursion in the GraphQL parser to protect against stack overflow. default: 500

Limit the number of tokens the GraphQL parser processes before aborting.

Limit the size of incoming HTTP requests read from the network, to protect against running out of memory. Default: 2000000 (2 MB)

Limit the maximum number of headers of incoming HTTP1 requests. Default is 100.

If router receives more headers than the buffer size, it responds to the client with "431 Request Header Fields Too Large".

Limit the maximum buffer size for the HTTP1 connection.

Default is ~400kib.

For HTTP2, limit the header list to a threshold of bytes. Default is 16kb.

If router receives more headers than allowed size of the header list, it responds to the client with "431 Request Header Fields Too Large".

Limit the depth of nested list fields in introspection queries to protect avoid generating huge responses. Returns a GraphQL error with { message: "Maximum introspection depth exceeded" } when nested fields exceed the limit. Default: true

Force a hot reload of the schema at regular intervals by injecting a timestamp comment into the SDL. This ensures schema reloads occur even when the functional schema content hasn't changed, which is useful for testing memory leaks during schema hot reloads.

The system automatically captures the last schema event and replays it with a timestamp comment added to make it appear "different" to the reload detection logic.

Force a hot reload of the configuration at regular intervals by replaying the last configuration event. This triggers the router's configuration change detection even when the configuration content hasn't actually changed.

The system automatically captures the last configuration event and replays it to force configuration reload processing.

This is a broken plugin for testing purposes only.

Expose query plan

Request recording configuration.

Restricted plugin (for testing purposes only)

Enable the broken plugin.

The recording plugin is disabled by default.

The path to the directory where recordings will be stored. Defaults to the current working directory.

Enable the restricted plugin (for testing purposes only)

Router configuration

Subgraph configuration

Connector configuration

The JWT configuration

List of JWKS used to verify tokens

HTTP header expected to contain JWT

Header value prefix

Whether to ignore any mismatched prefixes

Alternative sources to extract the JWT

Control the behavior when an error occurs during the authentication process.

Defaults to Error. When set to Continue, requests that fail JWT authentication will continue to be processed by the router, but without the JWT claims in the context. When set to Error, requests that fail JWT authentication will be rejected with a HTTP 403 error.

Retrieve the JWK Set

Polling interval for each JWKS endpoint in human-readable format; defaults to 60s

Expected issuers for tokens verified by that JWKS

If not specified, the issuer will not be checked.

Expected audiences for tokens verified by that JWKS

If not specified, the audience will not be checked.

List of accepted algorithms. Possible values are HS256, HS384, HS512, ES256, ES384, RS256, RS384, RS512, PS256, PS384, PS512, EdDSA

List of headers to add to the JWKS request

The name of the header

The value for the header

Configuration that will apply to all subgraphs.

Create a configuration that will apply only to a specific subgraph.

The ID for this access key.

The secret key used to sign requests.

The AWS region this chain applies to.

The service you're trying to access, eg: "s3", "vpc-lattice-svcs", etc.

Specify assumed role configuration.

Amazon Resource Name (ARN) for the role assumed when making requests

Uniquely identify a session when the same role is assumed by different principals or for different reasons.

Unique identifier that might be required when you assume a role in another account.

The AWS region this chain applies to.

The service you're trying to access, eg: "s3", "vpc-lattice-svcs", etc.

The profile name used by this provider

Specify assumed role configuration.

Create a configuration that will apply only to a specific source.

Reject unauthenticated requests

@authenticated, @requiresScopes and @policy directives

enables the @authenticated and @requiresScopes directives

generates the authorization error messages without modying the query

refuse a query entirely if any part would be filtered

authorization errors behaviour

log authorization errors

location of authorization errors in the GraphQL response

A map of subgraph name to connectors config for that subgraph

Map of subgraph_name.connector_source_name to source configuration

Enables connector debugging information on response extensions if the feature is enabled

The maximum number of requests for a connector source

When enabled, adds an entry to the context for use in coprocessors

{
  "context": {
    "entries": {
      "apollo_connectors::sources_in_query_plan": [
        { "subgraph_name": "subgraph", "source_name": "source" }
      ]
    }
  }
}

Enables Connect spec v0.2 during the preview.

Feature gate for Connect spec v0.3. Set to true to enable the using the v0.3 spec during the preview phase.

Feature gate for Connect spec v0.3. Set to true to enable the using the v0.3 spec during the preview phase.

Other values that can be used by connectors via {$config.<key>}

A map of @source(name:) to configuration for that source

Other values that can be used by connectors via {$config.<key>}

Override the @source(http: {baseURL:})

The maximum number of requests for this source

The url you'd like to offload processing to (can be overridden per-stage)

The timeout for external requests

Response validation defaults to true

The router stage request/response configuration

The supergraph stage request/response configuration

The execution stage request/response configuration

The subgraph stage request/response configuration

Use HTTP/2 to communicate with the coprocessor.

Specify a DNS resolution strategy to use when resolving the coprocessor URL.

The request configuration

The response configuration

Condition to trigger this stage

Send the headers

Send the context

Send the body

Send the SDL

Send the path

Send the method

The coprocessor URL for this stage (overrides the global URL if specified)

Condition to trigger this stage

Send the headers

Send the context

Send the body

Send the SDL

Send the HTTP status

The coprocessor URL for this stage (overrides the global URL if specified)

The request configuration

What information is passed to a router request/response stage

Condition to trigger this stage

Send the headers

Send the context

Send the body

Send the SDL

Send the method

The coprocessor URL for this stage (overrides the global URL if specified)

Condition to trigger this stage

Send the headers

Send the context

Send the body

Send the SDL

Send the HTTP status

The coprocessor URL for this stage (overrides the global URL if specified)

The request configuration

What information is passed to a router request/response stage

Send the headers

Send the context

Send the body

Send the SDL

Send the method

Send the query plan

The coprocessor URL for this stage (overrides the global URL if specified)

Send the headers

Send the context

Send the body

Send the SDL

Send the HTTP status

The coprocessor URL for this stage (overrides the global URL if specified)

What information is passed to a subgraph request/response stage

What information is passed to a subgraph request/response stage

What information is passed to a subgraph request/response stage

Condition to trigger this stage

Send the headers

Send the context

Send the body

Send the subgraph URI

Send the method URI

Send the service name

Send the subgraph request id

The coprocessor URL for this stage (overrides the global URL if specified)

Condition to trigger this stage

Send the headers

Send the context

Send the body

Send the service name

Send the http status

Send the subgraph request id

The coprocessor URL for this stage (overrides the global URL if specified)

The CSRF plugin is enabled by default.

Setting unsafe_disabled: true disables CSRF protection.

Override the headers to check for by setting custom_headers Note that if you set required_headers here, you may also want to have a look at your CORS configuration, and make sure you either:

• did not set any allow_headers list (so it defaults to mirror_request)
• added your required headers to the allow_headers list, as shown in the examples/cors-and-csrf/custom-headers.router.yaml files.

Enable demand control

The mode that the demand control plugin should operate in.

• Measure: The plugin will measure the cost of incoming requests but not reject them.
• Enforce: The plugin will enforce the cost of incoming requests and reject them if the algorithm indicates that they should be rejected.

The strategy used to reject requests.

Enable the diagnostics plugin

The socket address and port to listen on Defaults to 127.0.0.1:8089 Do not expose this endpoint to the internet as it exposes sensitive information.

Directory path for memory dump files Defaults to "/tmp/router-diagnostics" on Unix, or temp directory on other platforms

This directory will be created automatically if it doesn't exist. Note: Memory dumps are only generated on Linux platforms.

HTTP headers for the subgraph response

Data for query operations (excluding the special _entities field)

In maps nested in this one (but not at the top level), the __cacheTags key is special. Instead of representing a field that can be selected, when its parent field is selected its value is expected to be an array which is appended to the response.extensions["apolloCacheTags"] array.

Data for mutation operations

Entities that can be queried through Federation’s special _entities field

In maps directly in the top-level Vec (but not in other maps nested deeper), the __cacheTags key is special. Instead of representing a field that can be selected, when its parent entity is selected its contents are added to the response.extensions["apolloEntityCacheTags"] array.

Rules to apply to all subgraphs

Rules to specific subgraphs

Rules for connectors

Propagate/Insert/Remove headers from request

The name of the header

The value for the header

Specify header name

Specify context key to fetch value

The target header name

The path in the request body

The default if the path in the body did not resolve to an element

Map of subgraph_name.connector_source_name to configuration

Options applying to all sources across all subgraphs

Global configuration for error redaction. Applies to all subgraphs.

Overrides global configuration on a per-subgraph basis

Configure invalidation per subgraph

Enable or disable the entity caching feature

Expose cache keys in context

Global invalidation configuration

Entity caching evaluation metrics

options applying to all subgraphs

per subgraph options

Redis configuration

expiration for all keys for this subgraph, unless overridden by the Cache-Control header in subgraph responses

activates caching for this subgraph, overrides the global configuration

Context key used to separate cache sections per user

Invalidation configuration

Enable the invalidation

Shared key needed to request the invalidation endpoint

Specify on which path you want to listen for invalidation endpoint.

Listen address on which the invalidation endpoint must listen.

Number of keys to return at once from a redis SCAN command

Number of concurrent invalidation requests

enables metrics evaluating the benefits of entity caching

Metrics counter TTL

Adds the entity type name to attributes. This can greatly increase the cardinality

Whether the file upload plugin should be enabled (default: false)

Supported protocol configurations for file uploads

Configuration for multipart requests.

This protocol conforms to jaydenseric's multipart spec

Whether to enable the multipart protocol for file uploads (default: true)

The supported mode for the request (default: [MultipartRequestMode::Stream])

Resource limits for multipart requests

The maximum amount of files allowed for a single query (default: 4)

The maximum size of each file, in bytes (default: 5MB)

Configure invalidation per subgraph

Enable or disable the response caching feature

Enable debug mode for the debugger

Global invalidation configuration

Buffer size for known private queries (default: 2048)

options applying to all subgraphs

per subgraph options

Redis configuration

expiration for all keys for this subgraph, unless overridden by the Cache-Control header in subgraph responses

activates caching for this subgraph, overrides the global configuration

Context key used to separate cache sections per user

Invalidation configuration

List of URLs to the Redis cluster

Redis username if not provided in the URLs. This field takes precedence over the username in the URL

Redis password if not provided in the URLs. This field takes precedence over the password in the URL

Timeout for Redis fetch commands (default: 150ms)

Timeout for Redis insert commands (default: 500ms)

Inserts are processed asynchronously, so this will not affect response duration.

Timeout for Redis invalidation commands (default: 1s)

Timeout for Redis maintenance commands (default: 500ms)

Maintenance tasks are processed asynchronously, so this will not affect response duration.

namespace used to prefix Redis keys

TLS client configuration

Prevents the router from starting if it cannot connect to Redis

The size of the Redis connection pool (default: 5)

Interval for collecting Redis metrics (default: 1s)

Enable the invalidation

Shared key needed to request the invalidation endpoint

Specify on which path you want to listen for invalidation endpoint.

Listen address on which the invalidation endpoint must listen.

The directory where Rhai scripts can be found

The main entry point for Rhai script evaluation

Enable subscription

Select a subscription mode (callback or passthrough)

Configure subgraph subscription deduplication

This is a limit to only have maximum X opened subscriptions at the same time. By default if it's not set there is no limit.

It represent the capacity of the in memory queue to know how many events we can keep in a buffer

Enable callback mode for subgraph(s)

Enable passthrough mode for subgraph(s)

URL used to access this router instance, including the path configured on the Router

Heartbeat interval for callback mode (default: 5secs)

Listen address on which the callback must listen (default: 127.0.0.1:4000)

Specify on which path you want to listen for callbacks (default: /callback)

Specify on which subgraph we enable the callback mode for subscription If empty it applies to all subgraphs (passthrough mode takes precedence)

Configuration for all subgraphs

Configuration for specific subgraphs

Path on which WebSockets are listening

Which WebSocket GraphQL protocol to use for this subgraph possible values are: 'graphql_ws' | 'graphql_transport_ws' (default: graphql_ws)

Heartbeat interval for graphql-ws protocol (default: disabled)

Enable subgraph subscription deduplication. When enabled, multiple identical requests to the same subgraph will share one WebSocket connection in passthrough mode. (default: true)

List of headers to ignore for deduplication. Even if these headers are different, the subscription request is considered identical. For example, if you forward the "User-Agent" header, but the subgraph doesn't depend on the value of that header, adding it to this list will let the router dedupe subgraph subscriptions even if the header value is different.

Apollo reporting configuration

Instrumentation configuration

Instrumentation configuration

The Apollo Studio endpoint for exporting traces and metrics.

The Apollo Studio endpoint for exporting traces and metrics.

The name of the header to extract from requests when populating 'client name' for traces and metrics in Apollo Studio.

The name of the header to extract from requests when populating 'client version' for traces and metrics in Apollo Studio.

The buffer size for sending traces to Apollo. Increase this if you are experiencing lost traces.

Field level instrumentation for subgraphs via ftv1. ftv1 tracing can cause performance issues as it is transmitted in band with subgraph responses.

Percentage of traces to send via the OTel protocol when sending to Apollo Studio.

OTLP protocol used for OTel traces. Note this only applies if OTel traces are enabled and is only intended for use in tests.

OTLP protocol used for OTel metrics. Note this is only intended for use in tests.

To configure which request header names and values are included in trace data that's sent to Apollo Studio.

To configure which GraphQL variable values are included in trace data that's sent to Apollo Studio

Configuration for tracing.

Configuration for metrics.

Configure the way errors are transmitted to Apollo Studio

Set the signature normalization algorithm to use when sending Apollo usage reports.

Set the Apollo usage report reference reporting mode to use.

Enable field metrics that are generated without FTV1 to be sent to Apollo Studio.

Enable sending additional subgraph metrics to Apollo Studio via OTLP

Configuration for tracing batch processor.

The delay interval in milliseconds between two consecutive processing of batches. The default value is 5 seconds.

The maximum queue size to buffer spans for delayed processing. If the queue gets full it drops the spans. The default value is 2048.

The maximum number of spans to process in a single batch. If there are more than one batch worth of spans then it processes multiple batches of spans one batch after the other without any delay. The default value is 512.

The maximum duration to export a batch of data. The default value is 30 seconds.

Maximum number of concurrent exports

Limits the number of spawned tasks for exports and thus memory consumed by an exporter. A value of 1 will cause exports to be performed synchronously on the BatchSpanProcessor task. The default is 1.

Configuration for exporting metrics via OTLP.

Configuration for exporting metrics via Apollo usage reports.

Batch processor config for OTLP metrics.

The delay interval in milliseconds between two consecutive processing of batches. The default value is 5 seconds.

The maximum duration to export a batch of data. The default value is 30 seconds.

Batch processor config for Apollo usage report metrics.

The delay interval in milliseconds between two consecutive processing of batches. The default value is 5 seconds.

The maximum queue size to buffer spans for delayed processing. If the queue gets full it drops the reports. The default value is 2048.

The maximum duration to export a batch of data. The default value is 30 seconds.

Handling of errors coming from subgraph

Send error metrics via OTLP with additional dimensions [extensions.service, extensions.code]

Handling of errors coming from all subgraphs

Handling of errors coming from specified subgraphs

Send subgraph errors to Apollo Studio

Redact subgraph errors to Apollo Studio

Allows additional dimension extensions.code to be sent with errors even when redact is set to true. Has no effect when redact is false.

Logging configuration

Metrics configuration

Tracing configuration

Common configuration

Settings for logging to stdout.

Set a service.name resource in your metrics

Set a service.namespace attribute in your metrics

The Open Telemetry resource

Set to true to log to stdout.

The format to log to stdout.

The format to log to stdout when you're running on an interactive terminal. When configured it will automatically use this tty_format`` instead of the original format` when an interactive terminal is detected

Log rate limiting. The limit is set per type of log message

Set to true to limit the rate of log messages

Number of log lines allowed in interval per message

Interval for rate limiting

Common metrics configuration across all exporters

Open Telemetry native exporter configuration

Prometheus exporter configuration

Set a service.name resource in your metrics

Set a service.namespace attribute in your metrics

The Open Telemetry resource

Custom buckets for all histograms

Views applied on metrics

The instrument name you're targeting

Rename the metric to this name

This allows you to customize metric names for both OTLP and Prometheus exporters. Note: Prometheus will apply additional transformations (dots to underscores, unit suffixes). Apollo metrics are not affected by this rename - they will retain original names.

New description to set to the instrument

New unit to set to the instrument

New aggregation settings to set

An allow-list of attribute keys that will be preserved for the instrument.

Any attribute recorded for the instrument with a key not in this set will be dropped. If the set is empty, all attributes will be dropped, if None all attributes will be kept.

Enable otlp

The endpoint to send data to

The protocol to use when sending data

gRPC configuration settings

HTTP configuration settings

Batch processor settings

Temporality for export (default: Cumulative). Note that when exporting to Datadog agent use Delta.

The optional domain name for tls config. Note that domain name is will be defaulted to match the endpoint is not explicitly set.

The optional certificate authority (CA) certificate to be used in TLS configuration.

The optional cert for tls config

The optional private key file for TLS configuration.

gRPC metadata

Headers to send on report requests

Set to true to enable

resource_selector is used to select which resource to export with every metrics.

The listen address

The path where prometheus will be exposed

A way to expose trace id in response headers

Propagation configuration

Common configuration

OpenTelemetry native exporter configuration

Zipkin exporter configuration

Datadog exporter configuration

Expose the trace_id in response headers

Choose the header name to expose trace_id (default: apollo-trace-id)

Format of the trace ID in response headers

Select a custom request header to set your own trace_id (header value must be convertible from hexadecimal to set a correct trace_id)

Propagate baggage https://www.w3.org/TR/baggage/

Propagate trace context https://www.w3.org/TR/trace-context/

Propagate Jaeger

Propagate Datadog

Propagate Zipkin

Propagate AWS X-Ray

Choose the header name to expose trace_id (default: apollo-trace-id)

The trace ID format that will be used when propagating to subgraph services.

The trace service name

The trace service namespace

The sampler, always_on, always_off or a decimal between 0.0 and 1.0

Use datadog agent sampling. This means that all spans will be sent to the Datadog agent and the sampling.priority attribute will be used to control if the span will then be sent to Datadog

Whether to use parent based sampling

The maximum events per span before discarding

The maximum attributes per span before discarding

The maximum links per span before discarding

The maximum attributes per event before discarding

The maximum attributes per link before discarding

The Open Telemetry resource

Enable zipkin

The endpoint to send to

Batch processor configuration

Enable datadog

The endpoint to send to

batch processor configuration

Enable datadog span mapping for span name and resource name.

Fixes the span names, this means that the APM view will show the original span names in the operation dropdown.

Custom mapping to be used as the resource field in spans, defaults to: router -> http.route supergraph -> graphql.operation.name query_planning -> graphql.operation.name subgraph -> subgraph.name subgraph_request -> subgraph.name http_request -> http.route

Which spans will be eligible for span stats to be collected for viewing in the APM view. Defaults to true for request, router, query_parsing, supergraph, execution, query_planning, subgraph, subgraph_request, connect, connect_request and http_request.

Event configuration

Span configuration

Instrument configuration

Router service events

Subgraph service events

Supergraph service events

Connector events

Log the router request

Log the router response

Log the router error