From 134118580fe7e5db74719dfcd308782dc6428181 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Tue, 6 Feb 2024 15:55:01 -0500 Subject: [PATCH] Add performance tuning presets to standalone agent docs --- .../outputs/output-elasticsearch.asciidoc | 36 ++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc b/docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc index 0b6b0110d..5f602b795 100644 --- a/docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc +++ b/docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc @@ -531,8 +531,11 @@ include::output-shared-settings.asciidoc[tag=queue.mem.flush.timeout-setting] [[output-elasticsearch-performance-tuning-settings]] == Performance tuning settings -Settings that may affect performance. +Settings that may affect performance when sending data through the {es} output. +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. + +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. [cols="2*> to optimize your {agent} performance when sending data to an {es} output. + +Refer to <> 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. + +Performance tuning preset settings: + +*`balanced`*:: +Configure the default tuning setting values for "out-of-the-box" performance. + +*`throughput`*:: +Optimize the {es} output for throughput. + +*`scale`*:: +Optimize the {es} output for scale. + +*`latency`*:: +Optimize the {es} output to reduce latence. + +*`custom`*:: +Use the `custom` option to fine-tune the performance tuning settings individually. + +*Default:* `balanced` +// end::preset-setting[] + +// ============================================================================= + // tag::timeout-setting[] | [id="{type}-timeout-setting"]