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

APM mappings changes should be shown in release notes, improve guidance on customizations on the documentation #14813

Open
lucabelluccini opened this issue Dec 4, 2024 · 0 comments

Comments

@lucabelluccini
Copy link
Contributor

lucabelluccini commented Dec 4, 2024

This issue is to track 2 possible coupled items:

  • Whenever we change any field type in the built-in APM assets, it should show up in the release notes as breaking change
  • In the @custom doc section of our O11y docs, we should recommend to not override the fields we declare but prefer moving the fields to a different "namespace" (e.g. custom.myfield as it's less likely this will trigger a mapping conflict). In order to do so, the user would need to introduce an ingest pipeline which extracts the relevant fields and moves / processes them and finally stores them into custom.<fieldname>, plus add a mapping to the @custom` component template (example below)

In short, if a customer wants to extract a specific HTTP header, instead of overriding http.request.headers.myheader mappings, it would be better to:

  • define a traces-apm@custom ingest pipeline where we take http.request.headers.myheader and store it on custom.myheader
  • define a traces-apm@custom component template to specify the mapping of custom.myheader to whatever type the user wants
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant