Skip to content

Add docs for monitoring TBS #852

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

Merged
merged 5 commits into from
Mar 21, 2025
Merged

Add docs for monitoring TBS #852

merged 5 commits into from
Mar 21, 2025

Conversation

lahsivjar
Copy link
Contributor

@lahsivjar lahsivjar commented Mar 20, 2025

Documents the metrics produced by Tail-based sampler of APM Server and adds a few tips on how to monitor storage requirements.

Closes: elastic/apm-server#14996

CC: @elastic/obs-ds-intake-services (cannot ask for review directly)

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.

Some suggestions below!

@lahsivjar lahsivjar enabled auto-merge (squash) March 21, 2025 14:10
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.

@lahsivjar lahsivjar merged commit eb1c531 into elastic:main Mar 21, 2025
3 of 4 checks passed
@lahsivjar lahsivjar deleted the document-tbs branch March 21, 2025 17:01
@simitt
Copy link
Contributor

simitt commented Mar 24, 2025

@lahsivjar @colleenmcginnis is this going to be backported to 8.18+?

@lahsivjar
Copy link
Contributor Author

@lahsivjar @colleenmcginnis is this going to be backported to 8.18+?

@simitt I talked with @raultorrecilla about this and the decision was to keep the docs for 9.x for now. If required, I can create a PR for 8.18 too (it will require a bit more details for the vlog metric and a description on how to add lsm and vlog metric to get total storage size so will need to create a new PR).

@simitt
Copy link
Contributor

simitt commented Mar 24, 2025

Based on what we just discussed in the team sync, let's link this PR to the gh card about improving TBS docs (once the card is created) and see how to best include the information. IMO we will need to also provider better docs for 8.18 as this will be were large customers are for a long while.

@lahsivjar
Copy link
Contributor Author

IMO we will need to also provider better docs for 8.18 as this will be were large customers are for a long while.

@simitt Sounds good to me. I have created a PR for the 8.x branches (backported to 8.18, 8.17, and 8.16) with the updated docs.

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.

TBS: Document monitoring of disk space used by Tail Based Sampling in public docs.
4 participants