docs(router): circuit breaker in subgraph execution#86
Open
Copilot wants to merge 15 commits into
Open
Conversation
Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/df201bf4-472a-4cd5-8286-7cf523e0365d Co-authored-by: ardatan <[email protected]>
Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/adb0fa7f-61d4-4b30-b4ea-aa2ebf2aaf89 Co-authored-by: ardatan <[email protected]>
Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/a0c25c65-fc2d-4849-9d1f-e7e2cef52f58 Co-authored-by: ardatan <[email protected]>
Copilot created this pull request from a session on behalf of
ardatan
April 9, 2026 12:26
View session
ardatan
added
the
waits for release
ardatan
changed the title
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Router documentation describing the new circuit breaker behavior for subgraph execution and exposes the related traffic_shaping.circuit_breaker configuration in the reference docs (supporting graphql-hive/router#900).
Changes:
- Add a new “Circuit Breaker” section to the Performance Tuning guide (states, configuration examples, tuning guidance, and a metric mention).
- Extend the
traffic_shapingconfiguration reference to document thecircuit_breakeroption and its fields. - Update the “Outbound Options” section to include
circuit_breakeramong globally/per-subgraph overrideable settings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/documentation/content/docs/router/guides/performance-tuning.mdx | Introduces circuit breaker guide content, examples, and metrics/tuning notes. |
| packages/documentation/content/docs/router/configuration/traffic_shaping.mdx | Documents traffic_shaping.*.circuit_breaker config schema and links to the tuning guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…tuning.mdx Co-authored-by: Copilot <[email protected]>
ardatan
had a problem deploying
to
storybook-preview
GitHub Actions
Error
…tuning.mdx Co-authored-by: Copilot <[email protected]>
ardatan
had a problem deploying
to
storybook-preview
GitHub Actions
Error
…tuning.mdx Co-authored-by: Copilot <[email protected]>
ardatan
temporarily deployed
to
storybook-preview
GitHub Actions
Inactive
Member
|
@copilot fix linting |
Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/5cfb6b53-b887-4443-9179-567a36d06d91 Co-authored-by: ardatan <[email protected]>
Contributor
Author
ardatan
added
the
waits for release
Member
|
@copilot fix lint errors |
Agent-Logs-Url: https://github.com/graphql-hive/docs/sessions/afea84a9-65b6-4867-9ac5-67864ed1cc0e Co-authored-by: ardatan <[email protected]>
Contributor
Author
Fixed in 4151832. I applied formatting fixes to |
ardatan
approved these changes
May 13, 2026
ardatan
added a commit
to graphql-hive/router
that referenced
this pull request
May 14, 2026
Closes #489 Ref ROUTER-158 Documentation graphql-hive/docs#86 Preview of the feature doc https://b0d94292-hive-platform-docs.theguild.workers.dev/graphql/hive/docs/router/guides/performance-tuning#circuit-breaker Preview of the API doc https://b0d94292-hive-platform-docs.theguild.workers.dev/graphql/hive/docs/router/configuration/traffic_shaping#circuit_breaker ## Circuit Breaker implementation on Subgraph Execution Anything is thrown as SubgraphExecutorError is considered as an error by the circuit breaker. It uses the same logic that we have in usage reporting in Hive Console SDK with `recloser` library. Circuit breaker configuration is available for all subgraphs as a global configuration and subgraph-level configuration. Besides the implementation, the metrics are also added which is mentioned in the proposal inside the GitHub issue linked above. What are considered as errors by Circuit Breaker? - Everything that throws in the subgraph execution today incl. invalid JSON payloads, empty response bodies, connection errors etc. - In addition, all [500. 502, 503, 504] responses are considered as errors too by default. These status codes can be changed by the user. In that case, the original response is held in case of the circuit breaker throws. Then it is reused to keep the behavior of today. So those responses are not considered as an error by the execution engine itself but only for the circuit breaker. --------- Co-authored-by: theguild-bot <[email protected]> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Copilot <[email protected]> Co-authored-by: copilot-swe-agent[bot] <[email protected]>
dotansimha
reviewed
May 14, 2026
dotansimha
reviewed
May 14, 2026
dotansimha
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation of graphql-hive/router#900