From b6a1b2ebe02ccec27ddc50da8b7975b7f7086f5a Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 25 Apr 2025 19:26:29 +0100 Subject: [PATCH 1/7] apm: Document sampling.tail.ttl config --- solutions/observability/apm/tail-based-sampling.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/solutions/observability/apm/tail-based-sampling.md b/solutions/observability/apm/tail-based-sampling.md index 11b79da93..abfc677fc 100644 --- a/solutions/observability/apm/tail-based-sampling.md +++ b/solutions/observability/apm/tail-based-sampling.md @@ -71,6 +71,16 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten | APM Server binary | `sampling.tail.interval` | | Fleet-managed | `Interval` | +### Interval [sampling-tail-ttl-ref] + +FIXME + +| | | +| --- |---------------------| +| APM Server binary | `sampling.tail.ttl` | +| Fleet-managed | `TTL` | + + ### Policies [sampling-tail-policies-ref] Criteria used to match a root transaction to a sample rate. From f4224847fc7962998c1d55676bab586baa07f606 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 25 Apr 2025 19:27:37 +0100 Subject: [PATCH 2/7] TTL --- solutions/observability/apm/tail-based-sampling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solutions/observability/apm/tail-based-sampling.md b/solutions/observability/apm/tail-based-sampling.md index abfc677fc..bb3ffc701 100644 --- a/solutions/observability/apm/tail-based-sampling.md +++ b/solutions/observability/apm/tail-based-sampling.md @@ -71,7 +71,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten | APM Server binary | `sampling.tail.interval` | | Fleet-managed | `Interval` | -### Interval [sampling-tail-ttl-ref] +### TTL [sampling-tail-ttl-ref] FIXME From f246586c1e293295345737b0050acc4d2ef82d33 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Fri, 25 Apr 2025 19:28:46 +0100 Subject: [PATCH 3/7] Add more FIXME --- reference/apm/cloud/apm-settings.md | 3 +++ solutions/observability/apm/configure-apm-server.md | 3 +++ solutions/observability/apm/transaction-sampling.md | 9 +++++++++ 3 files changed, 15 insertions(+) diff --git a/reference/apm/cloud/apm-settings.md b/reference/apm/cloud/apm-settings.md index 80dfc1631..158b346bb 100644 --- a/reference/apm/cloud/apm-settings.md +++ b/reference/apm/cloud/apm-settings.md @@ -121,6 +121,9 @@ The following `apm-server.auth.anonymous.*` settings can be configured to restri `apm-server.sampling.tail.interval` : Synchronization interval for multiple APM Servers. Should be in the order of tens of seconds or low minutes. +`apm-server.sampling.tail.ttl` +: FIXME + `logging.level` : Sets the minimum log level. The default log level is error. Available log levels are: error, warning, info, or debug. diff --git a/solutions/observability/apm/configure-apm-server.md b/solutions/observability/apm/configure-apm-server.md index 14a7d13cf..90d4498eb 100644 --- a/solutions/observability/apm/configure-apm-server.md +++ b/solutions/observability/apm/configure-apm-server.md @@ -143,6 +143,9 @@ The following `apm-server.auth.anonymous.*` settings can be configured to restri `apm-server.sampling.tail.interval` : Synchronization interval for multiple APM Servers. Should be in the order of tens of seconds or low minutes. +`apm-server.sampling.tail.ttl` +: FIXME + `logging.level` : Sets the minimum log level. The default log level is error. Available log levels are: error, warning, info, or debug. diff --git a/solutions/observability/apm/transaction-sampling.md b/solutions/observability/apm/transaction-sampling.md index 0210d390e..950c2e6d6 100644 --- a/solutions/observability/apm/transaction-sampling.md +++ b/solutions/observability/apm/transaction-sampling.md @@ -312,6 +312,15 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten | APM Server binary | `sampling.tail.interval` | | Fleet-managed | `Interval` | +##### TTL [sampling-tail-ttl] + +FIXME + +| | | +| --- |---------------------| +| APM Server binary | `sampling.tail.ttl` | +| Fleet-managed | `TTL` | + ##### Policies [sampling-tail-policies] Criteria used to match a root transaction to a sample rate. From 4a0c31ba33b6f9ca77a7be57bb7f3a226669bdb7 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Tue, 6 May 2025 14:10:32 +0100 Subject: [PATCH 4/7] Update docs --- reference/apm/cloud/apm-settings.md | 7 ++++--- solutions/observability/apm/configure-apm-server.md | 8 +++++--- solutions/observability/apm/tail-based-sampling.md | 2 +- solutions/observability/apm/transaction-sampling.md | 2 +- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/reference/apm/cloud/apm-settings.md b/reference/apm/cloud/apm-settings.md index 158b346bb..088b5ddb7 100644 --- a/reference/apm/cloud/apm-settings.md +++ b/reference/apm/cloud/apm-settings.md @@ -51,6 +51,10 @@ If a setting is not supported by {{ech}}, you will get an error message when you Some settings that could break your cluster if set incorrectly are blocklisted. The following settings are generally safe in cloud environments. For detailed information about APM settings, check the [APM documentation](/solutions/observability/apm/configure-apm-server.md). :::: +### Version 9.0+ [ec_version_9_0] + +`apm-server.sampling.tail.ttl` +: Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. ### Version 8.0+ [ec_version_8_0_3] @@ -121,9 +125,6 @@ The following `apm-server.auth.anonymous.*` settings can be configured to restri `apm-server.sampling.tail.interval` : Synchronization interval for multiple APM Servers. Should be in the order of tens of seconds or low minutes. -`apm-server.sampling.tail.ttl` -: FIXME - `logging.level` : Sets the minimum log level. The default log level is error. Available log levels are: error, warning, info, or debug. diff --git a/solutions/observability/apm/configure-apm-server.md b/solutions/observability/apm/configure-apm-server.md index 90d4498eb..9c4636f9a 100644 --- a/solutions/observability/apm/configure-apm-server.md +++ b/solutions/observability/apm/configure-apm-server.md @@ -74,6 +74,11 @@ If a setting is not supported on {{ecloud}}, you will get an error message when Some settings that could break your cluster if set incorrectly are blocklisted. The following settings are generally safe in cloud environments. For detailed information about APM settings, check the [APM documentation](/solutions/observability/apm/configure-apm-server.md). :::: +### Version 9.0+ [ec_version_9_0] + +`apm-server.sampling.tail.ttl` +: Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. + ### Version 8.0+ [ec_version_8_0_3] This stack version removes support for some previously supported settings. These are all of the supported settings for this version: @@ -143,9 +148,6 @@ The following `apm-server.auth.anonymous.*` settings can be configured to restri `apm-server.sampling.tail.interval` : Synchronization interval for multiple APM Servers. Should be in the order of tens of seconds or low minutes. -`apm-server.sampling.tail.ttl` -: FIXME - `logging.level` : Sets the minimum log level. The default log level is error. Available log levels are: error, warning, info, or debug. diff --git a/solutions/observability/apm/tail-based-sampling.md b/solutions/observability/apm/tail-based-sampling.md index bb3ffc701..db0289624 100644 --- a/solutions/observability/apm/tail-based-sampling.md +++ b/solutions/observability/apm/tail-based-sampling.md @@ -73,7 +73,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten ### TTL [sampling-tail-ttl-ref] -FIXME +Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. Default: `30m` (30 minutes). (duration) | | | | --- |---------------------| diff --git a/solutions/observability/apm/transaction-sampling.md b/solutions/observability/apm/transaction-sampling.md index 950c2e6d6..969f3087d 100644 --- a/solutions/observability/apm/transaction-sampling.md +++ b/solutions/observability/apm/transaction-sampling.md @@ -314,7 +314,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten ##### TTL [sampling-tail-ttl] -FIXME +Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. Default: `30m` (30 minutes). (duration) | | | | --- |---------------------| From f7d7e7a7d73aab24a8cdffea412cefe577ce5609 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Tue, 6 May 2025 14:14:08 +0100 Subject: [PATCH 5/7] Update version --- reference/apm/cloud/apm-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/apm/cloud/apm-settings.md b/reference/apm/cloud/apm-settings.md index 088b5ddb7..29364cd9f 100644 --- a/reference/apm/cloud/apm-settings.md +++ b/reference/apm/cloud/apm-settings.md @@ -51,7 +51,7 @@ If a setting is not supported by {{ech}}, you will get an error message when you Some settings that could break your cluster if set incorrectly are blocklisted. The following settings are generally safe in cloud environments. For detailed information about APM settings, check the [APM documentation](/solutions/observability/apm/configure-apm-server.md). :::: -### Version 9.0+ [ec_version_9_0] +### Version 8.19+ and 9.1+ [ec_version_8_19_and_9_1] `apm-server.sampling.tail.ttl` : Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. From 6e66c7bfadbb8abe709b862a9190695f4e9e8414 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Tue, 6 May 2025 14:14:45 +0100 Subject: [PATCH 6/7] Update header --- solutions/observability/apm/configure-apm-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solutions/observability/apm/configure-apm-server.md b/solutions/observability/apm/configure-apm-server.md index 9c4636f9a..7d312afe3 100644 --- a/solutions/observability/apm/configure-apm-server.md +++ b/solutions/observability/apm/configure-apm-server.md @@ -74,7 +74,7 @@ If a setting is not supported on {{ecloud}}, you will get an error message when Some settings that could break your cluster if set incorrectly are blocklisted. The following settings are generally safe in cloud environments. For detailed information about APM settings, check the [APM documentation](/solutions/observability/apm/configure-apm-server.md). :::: -### Version 9.0+ [ec_version_9_0] +### Version 8.19+ and 9.1+ [ec_version_8_19_and_9_1] `apm-server.sampling.tail.ttl` : Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. From bd78b3490be622383a9feff7e19e182a3aa86802 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Tue, 6 May 2025 14:16:46 +0100 Subject: [PATCH 7/7] Style --- reference/apm/cloud/apm-settings.md | 2 +- solutions/observability/apm/configure-apm-server.md | 2 +- solutions/observability/apm/tail-based-sampling.md | 2 +- solutions/observability/apm/transaction-sampling.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/apm/cloud/apm-settings.md b/reference/apm/cloud/apm-settings.md index 29364cd9f..d33d4ce0e 100644 --- a/reference/apm/cloud/apm-settings.md +++ b/reference/apm/cloud/apm-settings.md @@ -54,7 +54,7 @@ Some settings that could break your cluster if set incorrectly are blocklisted. ### Version 8.19+ and 9.1+ [ec_version_8_19_and_9_1] `apm-server.sampling.tail.ttl` -: Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. +: Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases storage space requirements. ### Version 8.0+ [ec_version_8_0_3] diff --git a/solutions/observability/apm/configure-apm-server.md b/solutions/observability/apm/configure-apm-server.md index 7d312afe3..9599f45d4 100644 --- a/solutions/observability/apm/configure-apm-server.md +++ b/solutions/observability/apm/configure-apm-server.md @@ -77,7 +77,7 @@ Some settings that could break your cluster if set incorrectly are blocklisted. ### Version 8.19+ and 9.1+ [ec_version_8_19_and_9_1] `apm-server.sampling.tail.ttl` -: Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. +: Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases storage space requirements. ### Version 8.0+ [ec_version_8_0_3] diff --git a/solutions/observability/apm/tail-based-sampling.md b/solutions/observability/apm/tail-based-sampling.md index db0289624..a4a7f1517 100644 --- a/solutions/observability/apm/tail-based-sampling.md +++ b/solutions/observability/apm/tail-based-sampling.md @@ -73,7 +73,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten ### TTL [sampling-tail-ttl-ref] -Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. Default: `30m` (30 minutes). (duration) +Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases storage space requirements. Default: `30m` (30 minutes). (duration) | | | | --- |---------------------| diff --git a/solutions/observability/apm/transaction-sampling.md b/solutions/observability/apm/transaction-sampling.md index 969f3087d..4b492054b 100644 --- a/solutions/observability/apm/transaction-sampling.md +++ b/solutions/observability/apm/transaction-sampling.md @@ -314,7 +314,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten ##### TTL [sampling-tail-ttl] -Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases the required storage space. Default: `30m` (30 minutes). (duration) +Time-to-live (TTL) for trace events stored in the local storage of the APM Server during tail-based sampling. This TTL determines how long trace events are retained in the local storage while waiting for a sampling decision to be made. A greater TTL value increases storage space requirements. Default: `30m` (30 minutes). (duration) | | | | --- |---------------------|