Add content to APM User guide #6378
Conversation
mergify
bot
added
the
backport-skip
mergify
bot
removed
the
backport-skip
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
🤖 GitHub commentsTo re-run your PR in the CI, just comment with:
|
marclop
added
backport-7.16
docs/manage-storage.asciidoc
Outdated
| POST *-apm-*/_update_by_query | ||
| { | ||
| "query": { | ||
| "term": { | ||
| "service.name": { | ||
| "value": "current-service-name" | ||
| } | ||
| } | ||
| }, | ||
| "script": { | ||
| "source": "ctx._source.service.name = 'new-service-name'", | ||
| "lang": "painless" | ||
| } | ||
| } |
There was a problem hiding this comment.
I'm struggling to update this query. The _search works correctly, for example:
GET *-apm-*/_search
{
"query": {
"term": {
"service.name": {
"value": "opbeans-dotnet"
}
}
}
}
But running the script returns 0 updates.
There was a problem hiding this comment.
I'm not sure why this is necessary, but try adding ?expand_wildcards=all. I thought the default would match it... maybe a bug?
There was a problem hiding this comment.
That did it!
I don't think it's a bug. Reading into expand_wildcards, I can see that my APM indices are "hidden indices" so it makes sense that all would be needed to match a hidden index.
…content # Conflicts: # docs/integrations-index.asciidoc
|
@elastic/apm-server Unfortunately, this PR is blocking me. If it's alright with y'all, I'm going to merge it tomorrow morning (PDT) so I can keep moving forward with docs updates. I know you're all super busy right now, so we can always review later and make updates in a future PR 😄 |
|
@bmorelli25 sorry, please go ahead and merge and we can do a post-merge review. |
| [[view-edit-default-pipelines]] | ||
| === View or edit a default pipeline | ||
|
|
||
| To view or edit a default pipelines in {kib}, |
There was a problem hiding this comment.
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.
Let me know if I'm understanding this correctly:
- Fleet adds ingest pipelines for the APM integration using index templates that include pipeline index settings.
- Elasticsearch uses the index pattern in these index templates to match pipelines to APM data streams.
As an example, the index template traces-apm, matches traces-apm-* data streams and assigns the "traces-apm-7.16.0" pipeline:
- This, Fleet managed, index template ⬆️ will be overwritten on reinstall/upgrade.
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.
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 @simitt
Users 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.
Perfect. Thanks, Andrew!
There was a problem hiding this comment.
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?
(cherry picked from commit d9a7812)
(cherry picked from commit d9a7812)
Summary
This PR adds the following content to the APM Guide:
/docs/legacydirectory.Related issues
For elastic/observability-docs#1073.
PRs blocked by this PR