Skip to content

Commit b494ca8

Browse files
committed
Address PR comments
1 parent f19b9e5 commit b494ca8

File tree

1 file changed

+12
-14
lines changed
  • gateway/src/apicast/policy/request_unbuffered

1 file changed

+12
-14
lines changed

gateway/src/apicast/policy/request_unbuffered/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@
55
When enable this policy will dymanically sets the [`proxy_request_buffering: off`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering
66
) directive per service.
77

8-
98
## Technical details
109

11-
By default, NGINX reads the entire request body into memory (or buffers large requests into disk) before proxying it to the upstream server. However, reading bodies can become expensive, especially when requests with large payloads are sent.
10+
By default, NGINX reads the entire request body into memory or buffers large requests to disk before forwarding them to the upstream server. Reading bodies can become expensive, especially when sending requests containing large payloads.
1211

13-
For example, when the client sends 10GB, NGINX will buffer the entire 10GB to disk before sending anything to
14-
the upstream server.
12+
For example, when the client sends 10GB, NGINX will buffer the entire 10GB to disk before sending anything to the upstream server.
1513

16-
When `proxy_request_buffering` is in the chain, request buffering will be disabled and the request body will be sent to the proxied server immediately as it received. This can help minimize time spent sending data to a service and disk I/O for requests with big body. However, there are caveats and corner cases applied, [**Caveats**](#caveats)
14+
When the `request_unbuffered` is in the chain, request buffering is disabled, sending the request body to the proxied server immediately upon receiving it. This can help minimize time spent sending data to a service and disk I/O for requests with big body. However, there are caveats and corner cases applied, [**Caveats**](#caveats)
1715

1816
The policy also provides a consistent behavior across multiple scenarios like:
1917

@@ -30,10 +28,15 @@ The policy also provides a consistent behavior across multiple scenarios like:
3028

3129
## Why don't we also support disable response buffering?
3230

33-
The response buffering is enabled by default in NGINX (the [`proxy_buffering: on`]() directive). It does
34-
this to shield the backend against slow clients ([slowloris attack](https://en.wikipedia.org/wiki/Slowloris_(computer_security))).
31+
The response buffering is enabled by default in NGINX (the [`proxy_buffering: on`]() directive). It does this to shield the backend against slow clients ([slowloris attack](https://en.wikipedia.org/wiki/Slowloris_(computer_security))).
32+
33+
If the `proxy_buffering` is disabled, the upstream server keeps the connection open until all data is received by the client. NGINX [advises](https://www.nginx.com/blog/avoiding-top-10-nginx-configuration-mistakes/#proxy_buffering-off) against disabling `proxy_buffering` as it will potentially waste upstream server resources.
34+
35+
## Why does upstream receive a "Content-Length" header when the original request is sent with "Transfer-Encoding: chunked"
36+
37+
For a request with "small" body that fits into [`client_body_buffer_size`](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size) and with header "Transfer-Encoding: chunked", NGINX will always read and know the length of the body. Then it will send the request to upstream with the "Content-Length" header.
3538

36-
If the `proxy_buffering` is disabled, the upstream server will be forced to keep the connection open until all data has been received by the client. Thereforce, NGINX [advises](https://www.nginx.com/blog/avoiding-top-10-nginx-configuration-mistakes/#proxy_buffering-off) against disabling `proxy_buffering` as it will potentially waste upstream server resources.
39+
If a client uses chunked transfer encoding with HTTP/1.0, NGINX will always buffer the request body
3740

3841
## Example configuration
3942

@@ -89,11 +92,6 @@ Use with Camel Proxy policy
8992

9093
## Caveats
9194

92-
- Because APIcast allows defining mapping rules based on request content, ie `POST /some_path?a_param={a_value}`
93-
will match a request like `POST "http://apicast_host:8080/some_path"` with a form URL-encoded body like: `a_param=abc`
94-
, requests with `Content-type: application/x-www-form-urlencoded` will always be buffered regardless of the
95+
- APIcast allows defining of mapping rules based on request content. For example, `POST /some_path?a_param={a_value}` will match a request like `POST "http://apicast_host:8080/some_path"` with a form URL-encoded body like: `a_param=abc`, requests with `Content-type: application/x-www-form-urlencoded` will always be buffered regardless of the
9596
`request_unbuffered` policy is enabled or not.
96-
- For a request with "small" body that fits into [`client_body_buffer_size`](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size) and with header "Transfer-Encoding: chunked", NGINX will always read and know the length of the body.
97-
Then it will send the request to upstream with the "Content-Length" header.
98-
- If a client uses chunked transfer encoding with HTTP/1.0, NGINX will always buffer the request body
9997
- Disable request buffering could potentially expose the backend to [slowloris attack](https://en.wikipedia.org/wiki/Slowloris_(computer_security)). Therefore, we recommend to only use this policy when needed.

0 commit comments

Comments
 (0)