Skip to content

apm: Document sampling.tail.ttl config #1269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

apm: Document sampling.tail.ttl config #1269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b6a1b2e
apm: Document sampling.tail.ttl config
carsonip Apr 25, 2025
f422484
TTL
carsonip Apr 25, 2025
f246586
Add more FIXME
carsonip Apr 25, 2025
4a0c31b
Update docs
carsonip May 6, 2025
f7d7e7a
Update version
carsonip May 6, 2025
6e66c7b
Update header
carsonip May 6, 2025
bd78b34
Style
carsonip May 6, 2025
fefd357
Add guidance
carsonip May 21, 2025
ea5a8ec
Mention version requirement
carsonip May 21, 2025
f8e55c7
Merge branch 'main' into tbs-config-ttl
carsonip May 21, 2025
64080f2
Merge branch 'main' into tbs-config-ttl
carsonip May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions reference/apm/cloud/apm-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,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 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 storage space requirements. Should be at least 2 * Interval.

### Version 8.0+ [ec_version_8_0_3]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[to reviewer] I'm starting to think we should remove all 7.x and 8.x sections, as this is 9.0 docs. It still makes sense to document 9.0 vs 9.1+ though.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The entire (confusing) section may be removed as part of elastic/apm-server#13602


Expand Down
5 changes: 5 additions & 0 deletions solutions/observability/apm/configure-apm-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,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 8.19+ and 9.1+ [ec_version_8_19_and_9_1]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto


`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 storage space requirements. Should be at least 2 * Interval.

### 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:
Expand Down
12 changes: 12 additions & 0 deletions solutions/observability/apm/tail-based-sampling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@ 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-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 storage space requirements. Should be at least 2 * Interval.

Default: `30m` (30 minutes). (duration)

| | |
| --- | --- |
| APM Server binary | `sampling.tail.ttl` |
| Fleet-managed (version 9.1+) | `TTL` |


### Policies [sampling-tail-policies-ref]

Criteria used to match a root transaction to a sample rate.
Expand Down
Loading