Add configurable server header read timeout

[gwardwell]

This change exposes the server's header read timeout as the server.http.header_read_timeout configuration option.

By default, the server.http.header_read_timeout is set to previously hard-coded 10 seconds. A longer timeout can be configured using the server.http.header_read_timeout option.

server:
  http:
    header_read_timeout: 30s

---

Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

• Changes are compatible¹
• Documentation² completed
• Performance impact assessed and acceptable
• Tests added and passing³
  • Unit Tests
  • Integration Tests
  • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩

2. Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩

3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩

[svc-apollo-docs]

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 1 changed, 0 removed

* graphos/routing/(latest)/configuration.mdx

Build ID: b2627a81ee8c875f8d033c6c

URL: https://www.apollographql.com/docs/deploy-preview/b2627a81ee8c875f8d033c6c

[router-perf]

CI performance tests

• connectors-const - Connectors stress test that runs with a constant number of users
• const - Basic stress test that runs with a constant number of users
• demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
• demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
• enhanced-signature - Enhanced signature enabled
• events - Stress test for events with a lot of users and deduplication ENABLED
• events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
• events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
• events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
• events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
• events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
• extended-reference-mode - Extended reference mode enabled
• large-request - Stress test with a 1 MB request payload
• no-tracing - Basic stress test, no tracing
• reload - Reload test over a long period of time at a constant rate of users
• step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
• step-local-metrics - Field stats that are generated from the router rather than FTV1
• step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
• step - Basic stress test that steps up the number of users over time
• xlarge-request - Stress test with 10 MB request payload
• xxlarge-request - Stress test with 100 MB request payload

[glasser]

I'll leave full review up to Router experts, but this looks reasonable from a high level, modulo lint/changelog/docs/etc.

I think we should do better than Hyper and actually define the term "header read timeout" in our docs. Our understanding is that this a timeout applied to any incoming connection when it is in any state other than "request headers have been read", setting an amount of time for headers to be read; it applies both when the connection is fully idle and when a request has been started but the headers have not been completed.

[goto-bus-stop]

It might make sense to put this in the existing supergraph configuration rather than introducing a new server group. supergraph.listen, supergraph.connection_shutdown_timeout, supergraph.early_cancel and supergraph.experimental_log_on_broken_pipe are on a similar "level" as header_read_timeout. I don't feel that strongly though, maybe @BrynCooke has some input around that.

The implementation looks good to me, but it does require a changeset and documentation (at least in docs/source/routing/configuration.mdx).

[gwardwell]

@goto-bus-stop I discussed where to put it with @BrynCooke and we landed on server.http.header_read_timeout, but I'm good with changing it to supergraph.header_read_timeout if your team would prefer. I'm definitely not opinionated about config location.

I'll definitely add a changeset and documentation. I just wanted to land on code-complete (in case of changes like we're discussing) before I did.

[goto-bus-stop]

If it's already been discussed then I don't mind keeping it as it is :)

[BrynCooke]

@goto-bus-stop We need to start moving stuff out of the supergraph section, it's a dumping ground at the moment.
I think we should take a stand and start putting stuff where it should be and then move the existing config items.