From d998a2a0f0c6a21ce6c0d21cba223847baffc43c Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 4 Jul 2025 13:46:36 +0100 Subject: [PATCH 1/5] Fix config prefix --- solutions/observability/apm/tail-based-sampling.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/solutions/observability/apm/tail-based-sampling.md b/solutions/observability/apm/tail-based-sampling.md index 7a27c36977..37e8d4216c 100644 --- a/solutions/observability/apm/tail-based-sampling.md +++ b/solutions/observability/apm/tail-based-sampling.md @@ -62,7 +62,7 @@ Set to `true` to enable tail based sampling. Disabled by default. (bool) | | | | --- | --- | -| APM Server binary | `sampling.tail.enabled` | +| APM Server binary | `apm-server.sampling.tail.enabled` | | Fleet-managed | `Enable tail-based sampling` | ### Interval [sampling-tail-interval-ref] @@ -71,7 +71,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten | | | | --- | --- | -| APM Server binary | `sampling.tail.interval` | +| APM Server binary | `apm-server.sampling.tail.interval` | | Fleet-managed | `Interval` | ### Policies [sampling-tail-policies-ref] @@ -82,7 +82,7 @@ Policies map trace events to a sample rate. Each policy must specify a sample ra | | | | --- | --- | -| APM Server binary | `sampling.tail.policies` | +| APM Server binary | `apm-server.sampling.tail.policies` | | Fleet-managed | `Policies` | ### Storage limit [sampling-tail-storage_limit-ref] @@ -99,7 +99,7 @@ Default: `0GB`. (text) | | | | --- | --- | -| APM Server binary | `sampling.tail.storage_limit` | +| APM Server binary | `apm-server.sampling.tail.storage_limit` | | Fleet-managed | `Storage limit` | ## Policy-level tail-based sampling settings [apm-configuration-tbs-policy] From 2030700b06888c2c49228d74e7eb2d040f8e261e Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 4 Jul 2025 13:52:51 +0100 Subject: [PATCH 2/5] Add missing apm-server prefix to agent auth --- .../observability/apm/apm-agent-authorization.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/solutions/observability/apm/apm-agent-authorization.md b/solutions/observability/apm/apm-agent-authorization.md index 6fcaba3141..dc9aad30e8 100644 --- a/solutions/observability/apm/apm-agent-authorization.md +++ b/solutions/observability/apm/apm-agent-authorization.md @@ -63,7 +63,7 @@ Enable API key authorization by setting `enabled` to `true`. By default, `enable | | | | --- | --- | -| APM Server binary | `auth.api_key.enabled` | +| APM Server binary | `apm-server.auth.api_key.enabled` | | Fleet-managed | `API key for agent authentication` | ::::{tip} @@ -76,7 +76,7 @@ Each unique API key triggers one request to {{es}}. This setting restricts the n | | | | --- | --- | -| APM Server binary | `auth.api_key.limit` | +| APM Server binary | `apm-server.auth.api_key.limit` | | Fleet-managed | `Number of keys` | ### Secret token [_secret_token] @@ -85,17 +85,17 @@ Authorization token for sending APM data. The same token must also be set in eac | | | | --- | --- | -| APM Server binary | `auth.api_key.token` | +| APM Server binary | `apm-server.auth.api_key.token` | | Fleet-managed | `Secret token` | -## `auth.api_key.elasticsearch.*` configuration options [_auth_api_key_elasticsearch_configuration_options] +## `apm-server.auth.api_key.elasticsearch.*` configuration options [_auth_api_key_elasticsearch_configuration_options] ::::{note} ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "") The below options are only supported by the APM Server binary. -All of the `auth.api_key.elasticsearch.*` configurations are optional. If none are set, configuration settings from the `apm-server.output` section will be reused. +All of the `apm-server.auth.api_key.elasticsearch.*` configurations are optional. If none are set, configuration settings from the `apm-server.output` section will be reused. :::: @@ -119,7 +119,7 @@ The URL of the proxy to use when connecting to the {{es}} servers. The value may The HTTP request timeout in seconds for the {{es}} request. If nothing is configured, configuration settings from the `output` section will be reused. -## `auth.api_key.elasticsearch.ssl.*` configuration options [_auth_api_key_elasticsearch_ssl_configuration_options] +## `apm-server.auth.api_key.elasticsearch.ssl.*` configuration options [_auth_api_key_elasticsearch_ssl_configuration_options] SSL is off by default. Set `elasticsearch.protocol` to `https` if you want to enable `https`. From 860396ef763989559e929eaa674af4836792d347 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 4 Jul 2025 13:58:00 +0100 Subject: [PATCH 3/5] Update example config for TBS --- .../observability/apm/tail-based-sampling.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/solutions/observability/apm/tail-based-sampling.md b/solutions/observability/apm/tail-based-sampling.md index 37e8d4216c..705a7415b2 100644 --- a/solutions/observability/apm/tail-based-sampling.md +++ b/solutions/observability/apm/tail-based-sampling.md @@ -29,15 +29,15 @@ Tail-based sampling configuration options. ```yaml apm-server: - host: "localhost:8200" - rum: - enabled: true - -output: - elasticsearch: - hosts: ElasticsearchAddress:9200 - -max_procs: 4 + sampling: + tail: + enabled: true + interval: 1m + storage_limit: 0GB + policies: + - sample_rate: 1.0 + trace.outcome: failure + - sample_rate: 0.1 ``` :::::: From 9f524ae0dbf860ae891bc2704e8e2007465aab86 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 4 Jul 2025 14:02:20 +0100 Subject: [PATCH 4/5] Update agent auth example --- .../observability/apm/apm-agent-authorization.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/solutions/observability/apm/apm-agent-authorization.md b/solutions/observability/apm/apm-agent-authorization.md index dc9aad30e8..6f1bdd5ed3 100644 --- a/solutions/observability/apm/apm-agent-authorization.md +++ b/solutions/observability/apm/apm-agent-authorization.md @@ -26,15 +26,11 @@ Agent authorization APM Server configuration options. ```yaml apm-server: - host: "localhost:8200" - rum: - enabled: true - -output: - elasticsearch: - hosts: ElasticsearchAddress:9200 - -max_procs: 4 + auth: + api_key: + enabled: true + limit: 100 + token: "your_secret_token" ``` :::::: From 679e1113962aaa9903fd14db856cb6fa826c83ea Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 4 Jul 2025 14:06:26 +0100 Subject: [PATCH 5/5] Update TLS version --- solutions/observability/apm/apm-agent-authorization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solutions/observability/apm/apm-agent-authorization.md b/solutions/observability/apm/apm-agent-authorization.md index 6f1bdd5ed3..b21addd09d 100644 --- a/solutions/observability/apm/apm-agent-authorization.md +++ b/solutions/observability/apm/apm-agent-authorization.md @@ -129,7 +129,7 @@ Configure SSL verification mode. If `none` is configured, all server hosts and c ### `elasticsearch.ssl.supported_protocols` [_elasticsearch_ssl_supported_protocols] -List of supported/valid TLS versions. By default, all TLS versions from 1.0 to 1.2 are enabled. +List of supported/valid TLS versions. The default value is `[TLSv1.1, TLSv1.2, TLSv1.3]`. ### `elasticsearch.ssl.certificate_authorities` [_elasticsearch_ssl_certificate_authorities]