From e3c0695757b3799335214ae20af2e847c0d8cc00 Mon Sep 17 00:00:00 2001 From: Fae Charlton Date: Fri, 8 Dec 2023 08:11:42 -0500 Subject: [PATCH] Update changelog and configs for performance presets (#3879) * Add changelog and update default/reference configs for performance presets * update config templates --- _meta/config/common.p2.yml.tmpl | 1 + _meta/config/common.reference.p2.yml.tmpl | 5 +++++ _meta/config/elastic-agent.docker.yml.tmpl | 1 + changelog/fragments/1701882851-performance-presets.yaml | 8 ++++++++ elastic-agent.docker.yml | 1 + elastic-agent.reference.yml | 5 +++++ elastic-agent.yml | 1 + 7 files changed, 22 insertions(+) create mode 100644 changelog/fragments/1701882851-performance-presets.yaml diff --git a/_meta/config/common.p2.yml.tmpl b/_meta/config/common.p2.yml.tmpl index f7c82213305..7ca36f155a1 100644 --- a/_meta/config/common.p2.yml.tmpl +++ b/_meta/config/common.p2.yml.tmpl @@ -8,6 +8,7 @@ outputs: api_key: "example-key" #username: "elastic" #password: "changeme" + preset: balanced diff --git a/_meta/config/common.reference.p2.yml.tmpl b/_meta/config/common.reference.p2.yml.tmpl index e9643e6336b..325cd13ab18 100644 --- a/_meta/config/common.reference.p2.yml.tmpl +++ b/_meta/config/common.reference.p2.yml.tmpl @@ -9,6 +9,11 @@ outputs: # username: "elastic" # password: "changeme" + # Performance preset for elasticsearch outputs. One of "balanced", "throughput", + # "scale", "latency" and "custom". + # The default if unspecified is "custom". + preset: balanced + inputs: - type: system/metrics # Each input must have a unique ID. diff --git a/_meta/config/elastic-agent.docker.yml.tmpl b/_meta/config/elastic-agent.docker.yml.tmpl index 989c8c26ad9..134aecf3249 100644 --- a/_meta/config/elastic-agent.docker.yml.tmpl +++ b/_meta/config/elastic-agent.docker.yml.tmpl @@ -7,6 +7,7 @@ outputs: hosts: '${ELASTICSEARCH_HOSTS:http://elasticsearch:9200}' username: '${ELASTICSEARCH_USERNAME:elastic}' password: '${ELASTICSEARCH_PASSWORD:changeme}' + preset: balanced inputs: - type: system/metrics diff --git a/changelog/fragments/1701882851-performance-presets.yaml b/changelog/fragments/1701882851-performance-presets.yaml new file mode 100644 index 00000000000..54ea276a7fb --- /dev/null +++ b/changelog/fragments/1701882851-performance-presets.yaml @@ -0,0 +1,8 @@ +kind: feature +summary: Add performance presets to the Elasticsearch output configuration. + +description: Add a "preset" field to Elasticsearch output configurations that applies a set of configuration overrides based on a desired performance priority. Valid values are "balanced", "throughput", "scale", "latency" and "custom". The default if unspecified is "custom". + +component: all +pr: https://github.com/elastic/beats/pull/37259 +issue: https://github.com/elastic/elastic-agent/issues/3797 diff --git a/elastic-agent.docker.yml b/elastic-agent.docker.yml index b9353c99839..b9ad5e3f156 100644 --- a/elastic-agent.docker.yml +++ b/elastic-agent.docker.yml @@ -7,6 +7,7 @@ outputs: hosts: '${ELASTICSEARCH_HOSTS:http://elasticsearch:9200}' username: '${ELASTICSEARCH_USERNAME:elastic}' password: '${ELASTICSEARCH_PASSWORD:changeme}' + preset: balanced inputs: - type: system/metrics diff --git a/elastic-agent.reference.yml b/elastic-agent.reference.yml index 5f65481c4fd..db84c2e062e 100644 --- a/elastic-agent.reference.yml +++ b/elastic-agent.reference.yml @@ -15,6 +15,11 @@ outputs: # username: "elastic" # password: "changeme" + # Performance preset for elasticsearch outputs. One of "balanced", "throughput", + # "scale", "latency" and "custom". + # The default if unspecified is "custom". + preset: balanced + inputs: - type: system/metrics # Each input must have a unique ID. diff --git a/elastic-agent.yml b/elastic-agent.yml index 540b7a9a59e..0434c57ccb8 100644 --- a/elastic-agent.yml +++ b/elastic-agent.yml @@ -14,6 +14,7 @@ outputs: api_key: "example-key" #username: "elastic" #password: "changeme" + preset: balanced