Skip to content

Commit 118e6c9

Browse files
authored
[Docs] Clarify and setting descriptions (elastic#44278)
1 parent fff4a78 commit 118e6c9

18 files changed

+54
-18
lines changed

docs/reference/auditbeat/elasticsearch-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,16 @@ The default value is `false`.
108108

109109
### `worker` or `workers` [worker-option]
110110

111-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Elasticsearch in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
111+
`worker` or `workers` specifies the number of connections created per host for publishing events.
112+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
112113

113114
The default value is `1`.
114115

115116

116117
### `loadbalance` [_loadbalance]
117118

118119
When `loadbalance: true` is set, Auditbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Auditbeat can connect to at least one of its configured hosts.
120+
Use the `worker` or `workers` setting to specify the number of connections per host.
119121

120122
When `loadbalance: false` is set, Auditbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Auditbeat can connect to at least one of its configured hosts.
121123

docs/reference/auditbeat/logstash-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,16 @@ The default value is `false`.
120120

121121
### `worker` or `workers` [_worker_or_workers]
122122

123-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to {{ls}} in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
123+
`worker` or `workers` specifies the number of connections created per host for publishing events.
124+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
124125

125126
The default value is `1`.
126127

127128

128129
### `loadbalance` [loadbalance]
129130

130131
When `loadbalance: true` is set, Auditbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Auditbeat can connect to at least one of its configured hosts.
132+
Use the `worker` or `workers` setting to specify the number of connections per host.
131133

132134
When `loadbalance: false` is set, Auditbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Auditbeat can connect to at least one of its configured hosts. To rotate through the list of configured hosts over time, use this option in conjunction with the `ttl` setting to close the connection at the configured interval and choose a new target host.
133135

docs/reference/auditbeat/redis-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,16 @@ See [Change the output codec](/reference/auditbeat/configuration-output-codec.md
131131

132132
### `worker` or `workers` [_worker_or_workers_2]
133133

134-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Redis in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
134+
`worker` or `workers` specifies the number of connections created per host for publishing events.
135+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
135136

136137
The default value is `1`.
137138

138139

139140
### `loadbalance` [_loadbalance_2]
140141

141142
When `loadbalance: true` is set, Auditbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Auditbeat can connect to at least one of its configured hosts.
143+
Use the `worker` or `workers` setting to specify the number of connections per host.
142144

143145
When `loadbalance: false` is set, Auditbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Auditbeat can connect to at least one of its configured hosts.
144146

docs/reference/filebeat/elasticsearch-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,16 @@ The default value is `false`.
108108

109109
### `worker` or `workers` [worker-option]
110110

111-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Elasticsearch in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
111+
`worker` or `workers` specifies the number of connections created per host for publishing events.
112+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
112113

113114
The default value is `1`.
114115

115116

116117
### `loadbalance` [_loadbalance]
117118

118119
When `loadbalance: true` is set, Filebeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Filebeat can connect to at least one of its configured hosts.
120+
Use the `worker` or `workers` setting to specify the number of connections per host.
119121

120122
When `loadbalance: false` is set, Filebeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Filebeat can connect to at least one of its configured hosts.
121123

docs/reference/filebeat/logstash-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,16 @@ The default value is `false`.
122122

123123
### `worker` or `workers` [_worker_or_workers]
124124

125-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to {{ls}} in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
125+
`worker` or `workers` specifies the number of connections created per host for publishing events.
126+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
126127

127128
The default value is `1`.
128129

129130

130131
### `loadbalance` [loadbalance]
131132

132133
When `loadbalance: true` is set, Filebeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Filebeat can connect to at least one of its configured hosts.
134+
Use the `worker` or `workers` setting to specify the number of connections per host.
133135

134136
When `loadbalance: false` is set, Filebeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Filebeat can connect to at least one of its configured hosts. To rotate through the list of configured hosts over time, use this option in conjunction with the `ttl` setting to close the connection at the configured interval and choose a new target host.
135137

docs/reference/filebeat/redis-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,8 @@ See [Change the output codec](/reference/filebeat/configuration-output-codec.md)
131131

132132
### `worker` or `workers` [_worker_or_workers_2]
133133

134-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Redis in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
134+
`worker` or `workers` specifies the number of connections created per host for publishing events.
135+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
135136

136137
The default value is `1`.
137138

@@ -140,6 +141,7 @@ The default value is `1`.
140141
### `loadbalance` [_loadbalance_2]
141142

142143
When `loadbalance: true` is set, Filebeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Filebeat can connect to at least one of its configured hosts.
144+
Use the `worker` or `workers` setting to specify the number of connections per host.
143145

144146
When `loadbalance: false` is set, Filebeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Filebeat can connect to at least one of its configured hosts.
145147

docs/reference/heartbeat/elasticsearch-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,16 @@ The default value is `false`.
108108

109109
### `worker` or `workers` [worker-option]
110110

111-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Elasticsearch in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
111+
`worker` or `workers` specifies the number of connections created per host for publishing events.
112+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
112113

113114
The default value is `1`.
114115

115116

116117
### `loadbalance` [_loadbalance]
117118

118119
When `loadbalance: true` is set, Heartbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Heartbeat can connect to at least one of its configured hosts.
120+
Use the `worker` or `workers` setting to specify the number of connections per host.
119121

120122
When `loadbalance: false` is set, Heartbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Heartbeat can connect to at least one of its configured hosts.
121123

docs/reference/heartbeat/logstash-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,16 @@ The default value is `false`.
120120

121121
### `worker` or `workers` [_worker_or_workers]
122122

123-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to {{ls}} in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
123+
`worker` or `workers` specifies the number of connections created per host for publishing events.
124+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
124125

125126
The default value is `1`.
126127

127128

128129
### `loadbalance` [loadbalance]
129130

130131
When `loadbalance: true` is set, Heartbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Heartbeat can connect to at least one of its configured hosts.
132+
Use the `worker` or `workers` setting to specify the number of connections per host.
131133

132134
When `loadbalance: false` is set, Heartbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Heartbeat can connect to at least one of its configured hosts. To rotate through the list of configured hosts over time, use this option in conjunction with the `ttl` setting to close the connection at the configured interval and choose a new target host.
133135

docs/reference/heartbeat/redis-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,8 @@ See [Change the output codec](/reference/heartbeat/configuration-output-codec.md
131131

132132
### `worker` or `workers` [_worker_or_workers_2]
133133

134-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Redis in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
134+
`worker` or `workers` specifies the number of connections created per host for publishing events.
135+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
135136

136137
The default value is `1`.
137138

@@ -140,6 +141,7 @@ The default value is `1`.
140141
### `loadbalance` [_loadbalance_2]
141142

142143
When `loadbalance: true` is set, Heartbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Heartbeat can connect to at least one of its configured hosts.
144+
Use the `worker` or `workers` setting to specify the number of connections per host.
143145

144146
When `loadbalance: false` is set, Heartbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Heartbeat can connect to at least one of its configured hosts.
145147

docs/reference/metricbeat/elasticsearch-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,16 @@ The default value is `false`.
108108

109109
### `worker` or `workers` [worker-option]
110110

111-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Elasticsearch in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
111+
`worker` or `workers` specifies the number of connections created per host for publishing events.
112+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
112113

113114
The default value is `1`.
114115

115116

116117
### `loadbalance` [_loadbalance]
117118

118119
When `loadbalance: true` is set, Metricbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Metricbeat can connect to at least one of its configured hosts.
120+
Use the `worker` or `workers` setting to specify the number of connections per host.
119121

120122
When `loadbalance: false` is set, Metricbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Metricbeat can connect to at least one of its configured hosts.
121123

docs/reference/metricbeat/logstash-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,16 @@ The default value is `false`.
120120

121121
### `worker` or `workers` [_worker_or_workers]
122122

123-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to {{ls}} in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
123+
`worker` or `workers` specifies the number of connections created per host for publishing events.
124+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
124125

125126
The default value is `1`.
126127

127128

128129
### `loadbalance` [loadbalance]
129130

130131
When `loadbalance: true` is set, Metricbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Metricbeat can connect to at least one of its configured hosts.
132+
Use the `worker` or `workers` setting to specify the number of connections per host.
131133

132134
When `loadbalance: false` is set, Metricbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Metricbeat can connect to at least one of its configured hosts. To rotate through the list of configured hosts over time, use this option in conjunction with the `ttl` setting to close the connection at the configured interval and choose a new target host.
133135

docs/reference/metricbeat/redis-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,16 @@ See [Change the output codec](/reference/metricbeat/configuration-output-codec.m
131131

132132
### `worker` or `workers` [_worker_or_workers_2]
133133

134-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Redis in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
134+
`worker` or `workers` specifies the number of connections created per host for publishing events.
135+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
135136

136137
The default value is `1`.
137138

138139

139140
### `loadbalance` [_loadbalance_2]
140141

141142
When `loadbalance: true` is set, Metricbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Metricbeat can connect to at least one of its configured hosts.
143+
Use the `worker` or `workers` setting to specify the number of connections per host.
142144

143145
When `loadbalance: false` is set, Metricbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Metricbeat can connect to at least one of its configured hosts.
144146

docs/reference/packetbeat/elasticsearch-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,16 @@ The default value is `false`.
107107

108108
### `worker` or `workers` [worker-option]
109109

110-
`worker` or `workers` specifies the number of connections created per host for publishing events. It is best used with `loadbalance:true` which publishes events to Elasticsearch in parallel. Example: If you have 2 hosts and 3 workers, in total 6 connections are started (3 for each host).
110+
`worker` or `workers` specifies the number of connections created per host for publishing events.
111+
Refer to the `loadblance` setting for details about how the load balancing works to distribute requests across the Elasticsearch cluster nodes.
111112

112113
The default value is `1`.
113114

114115

115116
### `loadbalance` [_loadbalance]
116117

117118
When `loadbalance: true` is set, Packetbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Packetbeat can connect to at least one of its configured hosts.
119+
Use the `worker` or `workers` setting to specify the number of connections per host.
118120

119121
When `loadbalance: false` is set, Packetbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Packetbeat can connect to at least one of its configured hosts.
120122

0 commit comments

Comments
 (0)