Skip to content
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

Update docs after migrating from apm integration package to ES apm-data plugin in 8.15 #4239

Merged
merged 3 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/en/observability/apm/custom-index-template.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,19 @@ Select any of the APM index templates to view their relevant component templates
[id="index-template-view{append-legacy}"]
=== Edit the {es} index template

WARNING: Custom index mappings may conflict with the mappings defined by the APM integration
WARNING: Custom index mappings may conflict with the mappings defined by the {es} apm-data plugin
and may break the APM integration and APM UI in {kib}.
Do not change or customize any default mappings.

When you install the APM integration, {fleet} creates a default `@custom` component template for each data stream.
You can edit this `@custom` component template to customize your {es} indices.
The APM index templates by default reference a non-existent `@custom` component template for each data stream.
You can create or edit this `@custom` component template to customize your {es} indices.

First, determine which <<apm-data-streams,data stream>> you'd like to edit.
Then, open {kib} and navigate to **{stack-manage-app}** → **Index Management** → **Component Templates**.

Custom component templates are named following this pattern: `<name_of_data_stream>@custom`.
Search for the name of the data stream, like `traces-apm`, and select its custom component template.
Create one if it does not exist.
In this example, that'd be, `traces-apm@custom`.
Then click **Manage** → **Edit**.

Expand Down
3 changes: 2 additions & 1 deletion docs/en/observability/apm/data-streams.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ For example, consider traces that would originally be indexed to `traces-apm-def
]
----

For more about other ingest pipelines called by default, e.g. `traces-apm@custom`, see {fleet-guide}/data-streams.html#data-streams-pipelines[integration data streams ingest pipelines].
To find other ingest pipelines from the {es} apm-data plugin that are called by default, go to *Stack management* → *Ingest pipelines* {kibana-ref}/management.html[in Kibana] and search for `apm`.
Default APM ingest pipelines will follow the pattern `*-apm*@default-pipeline`.

For more custom APM ingest pipeline guides, see <<apm-ingest-pipelines,parse data using ingest pipelines>>.

Expand Down
3 changes: 1 addition & 2 deletions docs/en/observability/apm/ingest-pipelines.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Ingest pipelines preprocess and enrich APM documents before indexing them.
For example, a pipeline might define one processor that removes a field,
one that transforms a field, and another that renames a field.

The default APM pipelines are defined in index templates that {fleet} loads into {es}.
The default APM pipelines are defined in {es} apm-data plugin index templates.
{es} then uses the index pattern in these index templates to match pipelines to APM data streams.

[discrete]
Expand Down Expand Up @@ -65,6 +65,5 @@ If you prefer more guidance, see one of these tutorials:

* <<apm-filters-ingest-pipeline>> — Learn how to obfuscate passwords stored in the `http.request.body.original` field.
* <<apm-data-stream-rerouting>> — Learn how to reroute APM data to user-defined APM data streams.
* {fleet-guide}/data-streams-pipeline-tutorial.html[Transform data with custom ingest pipelines] — A basic Elastic integration tutorial where you learn how to add a custom field to incoming data.
Copy link
Member Author

Choose a reason for hiding this comment

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

This is a shame, as the tutorial is good, but some instructions do not apply to ES plugin

Copy link
Contributor

Choose a reason for hiding this comment

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

Tracking next steps for that tutorial in #4314.


// end::ingest-pipelines[]