Skip to content

Commit 6bd5e1b

Browse files
Add performance tuning presets to standalone agent docs (#896) (#902)
(cherry picked from commit 1561953) Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
1 parent 9b4198e commit 6bd5e1b

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc

+35-1
Original file line numberDiff line numberDiff line change
@@ -531,8 +531,11 @@ include::output-shared-settings.asciidoc[tag=queue.mem.flush.timeout-setting]
531531
[[output-elasticsearch-performance-tuning-settings]]
532532
== Performance tuning settings
533533

534-
Settings that may affect performance.
534+
Settings that may affect performance when sending data through the {es} output.
535535

536+
Use the `preset` option to automatically configure the group of performance tuning settings to optimize for `throughput`, `scale`, `latency`, or you can select a `balanced` set of performance specifications.
537+
538+
The performance tuning `preset` values take precedence over any settings that may be defined separately. If you want to change any setting, set `preset` to `custom` and specify the performance tuning settings individually.
536539

537540
[cols="2*<a"]
538541
|===
@@ -613,6 +616,37 @@ Set `max_retries` to a value less than 0 to retry until all events are published
613616

614617
// =============================================================================
615618

619+
// tag::preset-setting[]
620+
|
621+
[id="{type}-preset-setting"]
622+
`preset`
623+
624+
| Configures the full group of <<output-elasticsearch-performance-tuning-settings,performance tuning settings>> to optimize your {agent} performance when sending data to an {es} output.
625+
626+
Refer to <<es-output-settings-performance-tuning-settings>> for a table showing the group of values associated with any preset, and another table showing EPS (events per second) results from testing the different preset options.
627+
628+
Performance tuning preset settings:
629+
630+
*`balanced`*::
631+
Configure the default tuning setting values for "out-of-the-box" performance.
632+
633+
*`throughput`*::
634+
Optimize the {es} output for throughput.
635+
636+
*`scale`*::
637+
Optimize the {es} output for scale.
638+
639+
*`latency`*::
640+
Optimize the {es} output to reduce latence.
641+
642+
*`custom`*::
643+
Use the `custom` option to fine-tune the performance tuning settings individually.
644+
645+
*Default:* `balanced`
646+
// end::preset-setting[]
647+
648+
// =============================================================================
649+
616650
// tag::timeout-setting[]
617651
|
618652
[id="{type}-timeout-setting"]

0 commit comments

Comments
 (0)