From d5857f59e39daf774882c78a8d03d6fac053b69a Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Fri, 30 Apr 2021 11:37:24 -0400 Subject: [PATCH 1/2] Doc: Expand info for url option Fix link formatting Update outdated link to apache.org --- docs/index.asciidoc | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index f9bd88d..3be1c5b 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -86,10 +86,7 @@ output plugins. How many times should the client retry a failing URL. We highly recommend NOT setting this value to zero if keepalive is enabled. Some servers incorrectly end keepalives early requiring a retry! -Only IO related failures will be retried, such as connection timeouts and unreachable hosts. -Valid but non 2xx HTTP responses will always be retried, regardless of the value of this setting, -unless `retry_failed` is set. -Note: if `retry_non_idempotent` is NOT set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried. +Note: if `retry_non_idempotent` is set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried. [id="plugins-{type}s-{plugin}-cacert"] ===== `cacert` @@ -299,10 +296,9 @@ If you'd like to use an HTTP proxy . This supports multiple configuration syntax * Value type is <> * Default value is `60` -This module makes it easy to add a very fully configured HTTP client to logstash -based on [Manticore](https://github.com/cheald/manticore). -For an example of its usage see https://github.com/logstash-plugins/logstash-input-http_poller -Timeout (in seconds) for the entire request +This module makes it easy to add a very fully configured HTTP client to Logstash +based on https://github.com/cheald/manticore[Manticore]. +For an example, see {logstash-ref}/plugins-inputs-http_poller.html[input-http_poller] timeout (in seconds) for the entire request. [id="plugins-{type}s-{plugin}-retry_failed"] ===== `retry_failed` @@ -319,7 +315,6 @@ Set this to false if you don't want this output to retry failed requests * Default value is `false` If `automatic_retries` is enabled this will cause non-idempotent HTTP verbs (such as POST) to be retried. -This only affects connectivity related errors (see related `automatic_retries` setting). [id="plugins-{type}s-{plugin}-retryable_codes"] ===== `retryable_codes` @@ -369,7 +364,8 @@ Specify the truststore type here. One of `JKS` or `PKCS12`. Default is `JKS` * Value type is <> * There is no default value for this setting. -URL to use +URL to use. +This option is {logstash-ref}/event-dependent-configuration.html#sprintf[sprintf]-compliant if your configuration does not use `json-batch` with the <> or <> options. [id="plugins-{type}s-{plugin}-validate_after_inactivity"] ===== `validate_after_inactivity` @@ -380,12 +376,13 @@ URL to use How long to wait before checking if the connection is stale before executing a request on a connection using keepalive. You may want to set this lower, possibly to 0 if you get connection errors regularly Quoting the Apache commons docs (this client is based Apache Commmons): -'Defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer. Non-positive value passed to this method disables connection validation. This check helps detect connections that have become stale (half-closed) while kept inactive in the pool.' -See https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/conn/PoolingHttpClientConnectionManager.html#setValidateAfterInactivity(int)[these docs for more info] +'Defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer. Non-positive value passed to this method disables connection validation. +This check helps detect connections that have become stale (half-closed) while kept inactive in the pool.' +See the https://hc.apache.org/httpcomponents-client-5.0.x/[apache.org docs] for more info. [id="plugins-{type}s-{plugin}-common-options"] include::{include_path}/{type}.asciidoc[] -:default_codec!: +:default_codec!: \ No newline at end of file From e5b70a5634548300e47cc201956f4326cdd22aeb Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Fri, 30 Apr 2021 11:46:53 -0400 Subject: [PATCH 2/2] Tweaks --- docs/index.asciidoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 3be1c5b..041ebb8 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -86,6 +86,8 @@ output plugins. How many times should the client retry a failing URL. We highly recommend NOT setting this value to zero if keepalive is enabled. Some servers incorrectly end keepalives early requiring a retry! +Only IO related failures will be retried, such as connection timeouts and unreachable hosts. +Valid but non 2xx HTTP responses will always be retried, regardless of the value of this setting, unless `retry_failed` is set. Note: if `retry_non_idempotent` is set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried. [id="plugins-{type}s-{plugin}-cacert"] @@ -296,8 +298,7 @@ If you'd like to use an HTTP proxy . This supports multiple configuration syntax * Value type is <> * Default value is `60` -This module makes it easy to add a very fully configured HTTP client to Logstash -based on https://github.com/cheald/manticore[Manticore]. +This module helps you add a fully configured HTTP client to Logstash based on https://github.com/cheald/manticore[Manticore]. For an example, see {logstash-ref}/plugins-inputs-http_poller.html[input-http_poller] timeout (in seconds) for the entire request. [id="plugins-{type}s-{plugin}-retry_failed"]