Skip to content

Commit

Permalink
Add performance tuning presets to standalone agent docs (#896)
Browse files Browse the repository at this point in the history
  • Loading branch information
kilfoyle authored Feb 7, 2024
1 parent 3e43c97 commit 1561953
Showing 1 changed file with 35 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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*<a"]
|===
Expand Down Expand Up @@ -613,6 +616,37 @@ Set `max_retries` to a value less than 0 to retry until all events are published

// =============================================================================

// tag::preset-setting[]
|
[id="{type}-preset-setting"]
`preset`

| 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.

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.

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"]
Expand Down

0 comments on commit 1561953

Please sign in to comment.