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.
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
Add content to APM User guide #6378
Add content to APM User guide #6378
Changes from 12 commits
feff77a
a41b639
b704a80
21e5625
b07054e
3b3f229
5517e09
4bc3c5b
a1999e3
6d74877
f83246e
baa7237
b1d4b78
be00f22
ea0cfe1
282c6d8
6f9b385
6dab17c
aae58d8
31b51fc
4283eef
e210291
e752a59
469f031
a9f7eb3
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re "edit", we should make sure to document that the Fleet-managed ingest policy will be overwritten on reinstall/upgrade. Users can define their own custom ingest pipeline if needed, but they need make sure that they also call the package-provided pipeline.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me know if I'm understanding this correctly:
As an example, the index template
traces-apm
, matchestraces-apm-*
data streams and assigns the"traces-apm-7.16.0"
pipeline:Assuming the above is correct, then I see three scenarios:
If a user edits the Fleet managed index template to point to a new pipeline, they need to:
a. ensure the package-provided pipeline is also called
b. know that the index template will be overwritten on install/upgrade
If a user creates a custom component template with a higher priority that points to a new pipeline, they need to:
a. ensure the package-provided pipeline is also called
b. not sure what happens on upgrade here
If a user edits the pipeline directly, like the
"traces-apm-7.16.0"
pipeline, they need to:a. ensure the package-provided pipelines are still included
b. know that their edits will be overwritten on install/upgrade
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had thought that the default pipeline was defined in the
@settings
component template, which would allow it to be overridden. That is not the case, so #2 isn't possible actually. I believe at the moment users would be limited to #1 and #3. We'll need to improve this. CC @simittUsers shouldn't need to care about upgrades, but rather they should have some way of hooking their own custom pipeline into a predefined location in the Fleet-managed ingest pipeline.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect. Thanks, Andrew!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
started elastic/package-spec#129 a while back; @ruflin do you have any concerns when moving the
default_pipeline
to the component-template instead of the index-template to make it user overridable?