Skip to content

docs: clarify timeout hierarchy in traffic shaping documentation#8203

Merged
abernix merged 8 commits intodevfrom
docs/clarify-timeout-hierarchy
Sep 26, 2025
Merged

docs: clarify timeout hierarchy in traffic shaping documentation#8203
abernix merged 8 commits intodevfrom
docs/clarify-timeout-hierarchy

Conversation

@abernix
Copy link
Copy Markdown
Member

@abernix abernix commented Sep 5, 2025

Add explanation that router timeout should be >= subgraph timeouts.


Checklist

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

  • PR description explains the motivation for the change and relevant context for reviewing
  • PR description links appropriate GitHub/Jira tickets (creating when necessary)
  • Changeset is included for user-facing changes
  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Metrics and logs are added3 and documented
  • Tests added and passing4
    • Unit tests
    • Integration tests
    • Manual tests, as necessary

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. A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices.

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

Add explanation that router timeout should be >= subgraph timeouts.
@abernix abernix requested a review from a team as a code owner September 5, 2025 06:37
@apollo-librarian
Copy link
Copy Markdown
Contributor

apollo-librarian Bot commented Sep 5, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 1 changed, 0 removed
* graphos/routing/(latest)/performance/traffic-shaping.mdx

Build ID: e87536b69ea5bd0de7236fdc
Build Logs: View logs

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

@github-actions

This comment has been minimized.

Comment thread docs/source/routing/performance/traffic-shaping.mdx Outdated
Comment thread docs/source/routing/performance/traffic-shaping.mdx
Comment thread docs/source/routing/performance/traffic-shaping.mdx Outdated
Comment thread docs/source/routing/performance/traffic-shaping.mdx Outdated
Comment thread docs/source/routing/performance/traffic-shaping.mdx Outdated
@abernix abernix enabled auto-merge (squash) September 26, 2025 11:38
@abernix abernix merged commit 570d9c4 into dev Sep 26, 2025
15 checks passed
@abernix abernix deleted the docs/clarify-timeout-hierarchy branch September 26, 2025 11:49
@abernix abernix mentioned this pull request Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants