From 09ad1e7ff1b730208059ea0637fda4327d6671e9 Mon Sep 17 00:00:00 2001 From: James Peach Date: Thu, 26 Mar 2020 15:33:01 +1100 Subject: [PATCH 1/2] docs: correct the HTTP `request_timeout` documentation The documentation for the HTTP connection manager `request_timeout` says it is a timeout for idle requests, but it is actually the time to receive a complete request from the downstream client. This fixes #10481. Signed-off-by: James Peach --- .../http_connection_manager/v2/http_connection_manager.proto | 2 +- .../http_connection_manager/v3/http_connection_manager.proto | 2 +- docs/root/faq/configuration/timeouts.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto b/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto index e4d5b7b8ffc6..d9043e626435 100644 --- a/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto +++ b/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto @@ -336,7 +336,7 @@ message HttpConnectionManager { // timeout, although per-route idle timeout overrides will continue to apply. google.protobuf.Duration stream_idle_timeout = 24; - // A timeout for idle requests managed by the connection manager. + // The amount of time that Envoy will wait for the entire request to be received. // The timer is activated when the request is initiated, and is disarmed when the last byte of the // request is sent upstream (i.e. all decoding filters have processed the request), OR when the // response is initiated. If not specified or set to 0, this timeout is disabled. diff --git a/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto index 2f84fdd29d19..d0048e0a48f6 100644 --- a/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto +++ b/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto @@ -326,7 +326,7 @@ message HttpConnectionManager { // timeout, although per-route idle timeout overrides will continue to apply. google.protobuf.Duration stream_idle_timeout = 24; - // A timeout for idle requests managed by the connection manager. + // The amount of time that Envoy will wait for the entire request to be received. // The timer is activated when the request is initiated, and is disarmed when the last byte of the // request is sent upstream (i.e. all decoding filters have processed the request), OR when the // response is initiated. If not specified or set to 0, this timeout is disabled. diff --git a/docs/root/faq/configuration/timeouts.rst b/docs/root/faq/configuration/timeouts.rst index 65f3e9efce2c..4cdca3a57167 100644 --- a/docs/root/faq/configuration/timeouts.rst +++ b/docs/root/faq/configuration/timeouts.rst @@ -41,7 +41,7 @@ context request/stream is interchangeable. * The HTTP connection manager :ref:`request_timeout ` is the amount of time the connection manager will allow for the *entire request stream* to be - received by the client. + received from the client. .. attention:: From dd20a16b122f57bc4548024be0c0f76c77ed5ef7 Mon Sep 17 00:00:00 2001 From: James Peach Date: Fri, 27 Mar 2020 08:43:01 +1100 Subject: [PATCH 2/2] Add generated API files. Signed-off-by: James Peach --- .../http_connection_manager/v2/http_connection_manager.proto | 2 +- .../http_connection_manager/v3/http_connection_manager.proto | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/generated_api_shadow/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto b/generated_api_shadow/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto index e4d5b7b8ffc6..d9043e626435 100644 --- a/generated_api_shadow/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto +++ b/generated_api_shadow/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto @@ -336,7 +336,7 @@ message HttpConnectionManager { // timeout, although per-route idle timeout overrides will continue to apply. google.protobuf.Duration stream_idle_timeout = 24; - // A timeout for idle requests managed by the connection manager. + // The amount of time that Envoy will wait for the entire request to be received. // The timer is activated when the request is initiated, and is disarmed when the last byte of the // request is sent upstream (i.e. all decoding filters have processed the request), OR when the // response is initiated. If not specified or set to 0, this timeout is disabled. diff --git a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto index ecfd71b26334..7f67984e157e 100644 --- a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto +++ b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto @@ -352,7 +352,7 @@ message HttpConnectionManager { // timeout, although per-route idle timeout overrides will continue to apply. google.protobuf.Duration stream_idle_timeout = 24; - // A timeout for idle requests managed by the connection manager. + // The amount of time that Envoy will wait for the entire request to be received. // The timer is activated when the request is initiated, and is disarmed when the last byte of the // request is sent upstream (i.e. all decoding filters have processed the request), OR when the // response is initiated. If not specified or set to 0, this timeout is disabled.