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.

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

Clarify max_retries description for Filebeat and Winlogbeat #7180

Merged
merged 1 commit into from
May 26, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 41 additions & 25 deletions libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -283,19 +283,24 @@ endif::[]

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

ifeval::["{beatname_lc}" == "filebeat"]
Filebeat will ignore the `max_retries` setting and retry until all
events are published.
endif::[]
ifeval::["{beatname_lc}" != "filebeat"]
Set `max_retries` to a value less than 0 to retry until all events are published.
endif::[]

The default is 3.

endif::[]


===== `bulk_max_size`

The maximum number of events to bulk in a single Elasticsearch bulk API index request. The default is 50.
Expand Down Expand Up @@ -533,19 +538,23 @@ The number of seconds to wait for responses from the Logstash server before timi

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

ifeval::["{beatname_lc}" == "filebeat"]
Filebeat will ignore the `max_retries` setting and retry until all
events are published.
endif::[]
ifeval::["{beatname_lc}" != "filebeat"]
Set `max_retries` to a value less than 0 to retry until all events are published.
endif::[]

The default is 3.

endif::[]

===== `bulk_max_size`

The maximum number of events to bulk in a single Logstash request. The default is 2048.
Expand Down Expand Up @@ -728,20 +737,23 @@ brokers, topics, partition, and active leaders to use for publishing.

===== `max_retries`

The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.
ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

ifeval::["{beatname_lc}" == "filebeat"]
Filebeat will ignore the `max_retries` setting and retry until all
events are published.
endif::[]

ifeval::["{beatname_lc}" != "filebeat"]
ifeval::[("{beatname_lc}"!="filebeat") and ("{beatname_lc}"!="winlogbeat")]

The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.
endif::[]

The default is 3.

endif::[]

===== `bulk_max_size`

The maximum number of events to bulk in a single Kafka request. The default is 2048.
Expand Down Expand Up @@ -955,19 +967,23 @@ The Redis connection timeout in seconds. The default is 5 seconds.

===== `max_retries`

ifeval::[("{beatname_lc}"=="filebeat") or ("{beatname_lc}"=="winlogbeat")]

{beatname_uc} ignores the `max_retries` setting and retries indefinitely.

endif::[]

ifeval::["{beatname_lc}"!="filebeat" and "{beatname_lc}"!="winlogbeat"]

The number of times to retry publishing an event after a publishing failure.
After the specified number of retries, the events are typically dropped.

ifeval::["{beatname_lc}" == "filebeat"]
Filebeat will ignore the `max_retries` setting and retry until all
events are published.
endif::[]
ifeval::["{beatname_lc}" != "filebeat"]
Set `max_retries` to a value less than 0 to retry until all events are published.
endif::[]

The default is 3.

endif::[]


===== `bulk_max_size`

Expand Down
4 changes: 2 additions & 2 deletions libbeat/docs/shared-path-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
== Set up project paths

The `path` section of the +{beatname_lc}.yml+ config file contains configuration
options that define where {beatname_lc} looks for its files. For example, {beatname_uc}
options that define where {beatname_uc} looks for its files. For example, {beatname_uc}
looks for the Elasticsearch template file in the configuration path and writes
log files in the logs path.
ifeval::["{beatname_lc}"=="filebeat" or "{beatname_lc}"=="winlogbeat"]
Filebeat and Winlogbeat look for their registry files in the data path.
{beatname_uc} looks for its registry files in the data path.
endif::[]

Please see the <<directory-layout>> section for more details.
Expand Down