Skip to content

Commit fb060fe

Browse files
authored
docs(router): added missing docs for traffic_shaping.router.request_timeout (#136)
1 parent d278f67 commit fb060fe

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

packages/documentation/content/docs/router/configuration/traffic_shaping.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,25 @@ new long-lived connection attempts are rejected with `503 Service Unavailable` a
131131
This limit only activates when at least one of WebSocket or Subscriptions is enabled. Setting it
132132
to `0` disables the limit entirely.
133133

134+
### `router.request_timeout`
135+
136+
- **Type:** `string`
137+
- **Default:** `60s`
138+
139+
Maximum time the router will spend handling a single incoming client request, in duration string
140+
format (e.g. `60s` for 60 seconds, `1m` for 1 minute). The clock starts the moment the request is received and covers the entire pipeline — HTTP body recieving, parsing, validation, query planning, and execution —
141+
until a response is sent back to the client.
142+
143+
If a request exceeds this duration, it is aborted and the client receives a `504 Gateway Timeout` response with a `GATEWAY_TIMEOUT` error.
144+
145+
```yaml
146+
traffic_shaping:
147+
router:
148+
request_timeout: 60s
149+
```
150+
151+
> This is distinct from the outbound [`request_timeout`](#request_timeout), which bounds how long the router waits for an individual subgraph response.
152+
134153
### `router.tls` (Client ↔ Router)
135154

136155
Use this configuration field to make the router serve HTTPS traffic (TLS) and optionally require client certificates (mTLS).

0 commit comments

Comments
 (0)