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.

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 10 commits into
base: main
Choose a base branch
from

Conversation

carsonip
Copy link
Member

@carsonip carsonip commented Apr 25, 2025

⚠️ HOLD FOR 9.1 ⚠️

Document sampling.tail.ttl config

Related to #769
Part of elastic/apm-server#13525

Copy link
Member Author

@carsonip carsonip left a comment

Choose a reason for hiding this comment

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

I wonder if we should hold off from merging it until 9.1 and 8.19 release, because having these unreleased versions in public docs can be confusing.

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

### 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
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

This looks good to me, but if you don't want this to be published until 9.1 you should hold off on merging as you mentioned.

(Spoiler: We're working on some changes to how to handle PRs like this that contain content for future versions and how to annotate version applicability of individual settings. If these features are available in docs-builder before the 9.1 release, I'll make updates here.)

| | |
| --- |---------------------|
| APM Server binary | `sampling.tail.ttl` |
| Fleet-managed | `TTL` |
Copy link
Member Author

Choose a reason for hiding this comment

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

FIXME: add a note about fleet managed is only available from 9.1

| | |
| --- |---------------------|
| APM Server binary | `sampling.tail.ttl` |
| Fleet-managed | `TTL` |
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants