[Profiling] Improve docs on how to manage storage #3247
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With this commit we restructure the Universal Profiling documentation and add a new menu item about managing storage. It contains a new section that explains how to customize the ILM policy (usually to customize the retention period or to take advantage of data tiers) and moves the probabilistic profiling documentation also into this section.
|
A documentation preview will be available soon: |
|
This pull request does not have a backport label. Could you fix it @danielmitterdorfer? 🙏
|
mergify
bot
added
the
backport-skip
|
This documentation is aligned with https://www.elastic.co/guide/en/apm/guide/current/ilm-how-to.html. |
|
|
||
| Index lifecycle policies allow you to automate the lifecycle of your profiling indices as they grow and age. A default policy is applied, but can be customized depending on your business needs. | ||
|
|
||
| See {ref}/index-lifecycle-management.html[Manage the index lifecycle] to learn more. |
There was a problem hiding this comment.
Suggested change
| See {ref}/index-lifecycle-management.html[Manage the index lifecycle] to learn more. |
We might want to hold off on the link to start the page unless we want the user to leave the page right away.
There was a problem hiding this comment.
Good point, I've moved the link now to a tip cd5341f which appears in the context of creating a custom policy.
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
|
Thanks for the review! I've applied the suggestions and moved the link to the ILM docs down where it can be read in the context of creating a new ILM policy. |
rockdaboot
reviewed
Sep 27, 2023
| @@ -7,8 +7,6 @@ See the following sections for more information: | |||
| * <<profiling-tag-data-query, Tag data for querying>>: Tag data collected by the host-agent into multiple logical groups so they can be queried in Kibana. | |||
| * <<profiling-add-symbols, Add symbols for native frames>>: Push symbols to your cluster so you can see function names and line numbers in traces of applications written in programming languages that compile to native code (C, C++, Rust, Go, etc.). | |||
| * <<profiling-use-a-proxy,Use a proxy>>: Set up an HTTP proxy if your infrastructure host-agent installation needs one to reach {ecloud}. | |||
| * <<profiling-probabilistic-profiling, Configure probabilistic profiling>>: Configure the Universal Profiling agent to run in probabilistic profiling mode. | |||
There was a problem hiding this comment.
No. I've moved this intentionally because, related to ILM, probabilistic profiling can be used to control how much storage profiling requires.
christos68k
previously approved these changes
Sep 27, 2023
docs/en/observability/profiling-index-lifecycle-management.asciidoc
Outdated
Show resolved
Hide resolved
…iidoc Co-authored-by: Christos Kalkanis <[email protected]>
mdbirnstiehl
previously approved these changes
Sep 27, 2023
…iidoc Co-authored-by: Mike Birnstiehl <[email protected]>
danielmitterdorfer
dismissed stale reviews from mdbirnstiehl and rockdaboot
via
e976631
mdbirnstiehl
approved these changes
Sep 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With this commit we restructure the Universal Profiling documentation and add a new menu item about managing storage. It contains a new section that explains how to customize the ILM policy (usually to customize the retention period or to take advantage of data tiers) and moves the probabilistic profiling documentation also into this section.
Relates elastic/elasticsearch#99909