Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HTTP Connection manager documents request_timeout as an idle timeout #10481

Closed
jpeach opened this issue Mar 23, 2020 · 2 comments · Fixed by #10533
Closed

HTTP Connection manager documents request_timeout as an idle timeout #10481

jpeach opened this issue Mar 23, 2020 · 2 comments · Fixed by #10533
Labels
area/docs help wanted Needs help!

Comments

@jpeach
Copy link
Contributor

jpeach commented Mar 23, 2020

Description:

The HttpConnectionManager.request_timeout is documented as:

A timeout for idle requests managed by the connection manager. 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.

The second sentence describes an active request, but the first sentence says this is a timer for "idle requests". Maybe this language can be clarified?

Relevant Links:

Any extra documentation required to understand the issue.

https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/filter/network/http_connection_manager/v2/http_connection_manager.proto.html
@mattklein123
Copy link
Member

Yes the idle part is wrong. Doc PR appreciated. Please also reconcile with https://www.envoyproxy.io/docs/envoy/latest/faq/configuration/timeouts

@jpeach
Copy link
Contributor Author

jpeach commented Mar 23, 2020

Thanks for the confirmation @mattklein123. I should be able to send a PR later in the week.

jpeach added a commit to jpeach/envoy that referenced this issue Mar 26, 2020
@jpeach
docs: correct the HTTP request_timeout documentation
09ad1e7 
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 envoyproxy#10481.

Signed-off-by: James Peach <jpeach@apache.org>
@jpeach jpeach mentioned this issue Mar 26, 2020
Merged
mattklein123 pushed a commit that referenced this issue Mar 26, 2020
@jpeach
docs: correct the HTTP request_timeout documentation (#10533)
986e941 
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 <jpeach@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs help wanted Needs help!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: correct the HTTP request_timeout documentation jpeach/envoy
2 participants
@jpeach @mattklein123