Traffic shaping

The Apollo Router provides support for traffic shaping.

Currently features are limited, but are expected to grow over time:

• Sub-query deduplication - Identical, in-flight, non-mutation sub-queries are compressed into a single request.
• Variables deduplication - Subgraph requests body is compressed to deduplicate variables.
• Compression - Subgraph requests body and responses body are compressed in the specified compression algorithm (gzip, br, deflate).

Configuration

To configure traffic shaping add the traffic_shaping plugin to your router.yaml:

1
traffic_shaping:
2
  variables_deduplication: true # Enable the variables deduplication optimization
3
  all:
4
    query_deduplication: true # Enable query deduplication for all subgraphs.
5
    compression: br # Enable brotli compression for all subgraphs
6
  subgraphs:
7
    products:
8
      query_deduplication: false # Disable query deduplication for products.
9
      compression: gzip # Enable gzip compression only for subgraph products

Note that configuration in the subgraphs section will take precedence over that in the all section.

Sub-query deduplication

Deduplication will cause any identical, in-flight, non-mutation sub-queries to be merged into a single request. This can reduce network bandwidth and CPU at your subgraph.

Note that only in flight requests are deduplicated.

Variables deduplication

Variables deduplication will cause any identical variables in the sub-request body to be merged into an unique list of variables. This can reduce network bandwidth and CPU at your subgraph.

Compression

You can enable compression on subgraph requests and responses. Available compression algorithms are: gzip, br, deflate.