Document Sink connection configurations: socket_timeout and connect_t… #563
Conversation
…imeout Signed-off-by: Han Jiang <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #563 +/- ##
============================================
- Coverage 92.28% 92.17% -0.12%
+ Complexity 569 566 -3
============================================
Files 71 71
Lines 1725 1725
Branches 144 144
============================================
- Hits 1592 1590 -2
Misses 102 102
- Partials 31 33 +2
Continue to review full report at Codecov.
|
| @@ -74,6 +74,10 @@ Default is null. | |||
|
|
|||
| - `insecure`: A boolean flag to turn off SSL certificate verification. If set to true, CA certificate verification will be turned off and insecure HTTP requests will be sent. Default to `false`. | |||
|
|
|||
| - `socket_timeout`(optional): An integer value indicates the timeout in milliseconds for waiting for data (or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default if applicable). Default: -1. | |||
There was a problem hiding this comment.
A negative value is interpreted as undefined (system default if applicable). Default: -1.
This says that a negative value is undefined and then says the default is negative.
I know this comes from the Apache documentation. But, this is confusing in the context of the Data Prepper documentation.
There might be a better way to state this. Maybe even saying that this value is part of the underlying HTTP framework would help.
And what is the system in system default? Data Prepper, the OS? Once I read the Apache HTTP documentation it was clear, because I knew the context better. But here it is a little confusing since the system could be Data Prepper.
There was a problem hiding this comment.
Good point!
I re-phrased the sentence to something like "If this timeout value is either negative or not set, the underlying Apache HttpClient would rely on operating system settings for managing connection timeouts", hoping it's clearer now. Let me know if you have further suggestions. Thanks.
…sers. Signed-off-by: Han Jiang <[email protected]>
opensearch-project#563) * Document Sink connection configurations: socket_timeout and connect_timeout Signed-off-by: Han Jiang <[email protected]> * Re-phrase timeout parameter descriptions to make them clearer to DP users. Signed-off-by: Han Jiang <[email protected]>
…imeout
Signed-off-by: Han Jiang [email protected]
Description
Document Sink connection configurations:
socket_timeoutandconnect_timeoutReference: https://www.javadoc.io/doc/org.apache.httpcomponents/httpclient/4.5.5/org/apache/http/client/config/RequestConfig.html#getConnectTimeout()
Issues Resolved
NA
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.