-
Notifications
You must be signed in to change notification settings - Fork 25.6k
Clean up network setting docs #88929
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.
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
Clean up network setting docs #88929
Conversation
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-distributed (Team:Distributed) |
- Add types for all params - Remove mention of JDKs before 11 - Clarify some wording Co-authored-by: Stef Nestor <[email protected]>
f73bd52 to
23427f4
Compare
lockewritesdocs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some suggested changes based on the setting type and the default values.
docs/reference/modules/http.asciidoc
Outdated
| Configures whether detailed errors may be returned in HTTP responses. Defaults | ||
| to `true`, which means that HTTP requests which include | ||
| <<common-options-error-options,`?error_trace` URI parameter>> will return a | ||
| detailed error message including a stack trace if they encounter an exception. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Configures whether detailed errors may be returned in HTTP responses. Defaults | |
| to `true`, which means that HTTP requests which include | |
| <<common-options-error-options,`?error_trace` URI parameter>> will return a | |
| detailed error message including a stack trace if they encounter an exception. | |
| Configures whether detailed errors are returned in HTTP responses. Defaults | |
| to `true`, which means that HTTP requests that include the | |
| <<common-options-error-options,`?error_trace`>> parameter will return a | |
| detailed error message including a stack trace if they encounter an exception. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think may be is correct here. By default we don't return detailed errors even if http.detailed_errors.enabled: true - this setting just permits the use of the ?error_trace parameter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See 72be4ee for an alternative.
| Defaults to `network.tcp.keep_alive`. | ||
| (<<static-cluster-setting,Static>>, boolean) | ||
| Configures the `SO_KEEPALIVE` option for this socket, which determines whether | ||
| it sends TCP keepalive probes. Defaults to `network.tcp.keep_alive`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| it sends TCP keepalive probes. Defaults to `network.tcp.keep_alive`. | |
| it sends TCP keepalive probes. Defaults to `true`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a boolean setting, which I believe defaults to true.
|
Thanks @lockewritesdocs. The |
lockewritesdocs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the explanation @DaveCTurner. I resolved the comments relating to suggested changes on those settings. Merge away 🦖
Clean up network setting docs - Add types for all params - Remove mention of JDKs before 11 - Clarify some wording Co-authored-by: Stef Nestor <[email protected]>
💔 Backport failed
You can use sqren/backport to manually backport by running |
Clean up network setting docs - Add types for all params - Remove mention of JDKs before 11 - Clarify some wording Co-authored-by: Stef Nestor <[email protected]> Co-authored-by: Stef Nestor <[email protected]>
|
@DaveCTurner, it looks like the 8.3 backport failed. |
Clean up network setting docs - Add types for all params - Remove mention of JDKs before 11 - Clarify some wording Co-authored-by: Stef Nestor <[email protected]>
|
Thanks, yes, I did a custom bespoke artisanal backport to 8.3 in a42fc90. |
I'm assuming that you physically lifted the changes into the 8.3 branch, and then used a vintage bellows to propagate them through the code base. |
Co-authored-by: Stef Nestor [email protected]