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

docs: Document custom field mappings #11997

Merged
merged 5 commits into from
Nov 30, 2023

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Nov 2, 2023

Preview: View the Elasticsearch index template

Motivation/summary

Adds more information to View the Elasticsearch index template including:

  • How to add custom field mappings and at least one practical example
  • How to add runtime fields and at least one practical example

@bmorelli25 these ☝️ are the topics included in the initial issue, but should we also add the following while we're updating this page?

  • How to add/update metadata (in the Logistics step) and at least one practical example
  • How to use dynamic templates and at least one practical example
  • Available advanced options and when to use them
  • How to add aliases and at least one practical example

Also, how far back should we backport?

Checklist

Related issues

Closes elastic/observability-docs#2206

@colleenmcginnis colleenmcginnis added the backport-8.11 Automated backport with mergify label Nov 2, 2023
@colleenmcginnis colleenmcginnis self-assigned this Nov 2, 2023
@bmorelli25
Copy link
Member

My thoughts:

How to add/update metadata (in the Logistics step) and at least one practical example

I suppose we could add something here about how you can add arbitrary version numbers and metadata if they help you outside of the product. I'd be more tempted to just add a quick sentence or two and link to this page for more details: https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-component-template.html#component-templates-metadata

How to use dynamic templates and at least one practical example

If we had a good example of how our users might use this feature, then it would be very easy to add something here.
@elastic/apm-server any recommendations on how someone might use dynamic mappings with APM?

Available advanced options and when to use them

I don't know enough about this and the potential it does/doesn't have to mess up the APM app if folks touch these settings

How to add aliases and at least one practical example

Similar response from me here.

cc @axw for the tech lead perspective on these questions

@bmorelli25 bmorelli25 added backport-8.8 Automated backport with mergify backport-8.9 Automated backport with mergify backport-8.10 Automated backport with mergify labels Nov 6, 2023
@axw
Copy link
Member

axw commented Nov 13, 2023

I can't think of any common use cases related to the APM data streams/index templates for dynamic templates, advanced mapping options, or aliases.

@simitt
Copy link
Contributor

simitt commented Nov 24, 2023

I can't think of any common use cases related to the APM data streams/index templates for dynamic templates, advanced mapping options, or aliases.

++
Is there a specific request to add docs for these? Based on previous user questions, I'd say that describing how to customize component templates for adding field mappings and how to change retention periods is the most critical piece (don't remember anyone asking for dynamic templates).

@colleenmcginnis colleenmcginnis marked this pull request as ready for review November 27, 2023 17:12
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner November 27, 2023 17:12
@colleenmcginnis colleenmcginnis requested review from bmorelli25 and removed request for bmorelli25 November 28, 2023 21:14
@simitt simitt enabled auto-merge (squash) November 30, 2023 16:03
@simitt simitt merged commit 537a3c8 into elastic:main Nov 30, 2023
5 checks passed
mergify bot pushed a commit that referenced this pull request Nov 30, 2023
mergify bot pushed a commit that referenced this pull request Nov 30, 2023
mergify bot pushed a commit that referenced this pull request Nov 30, 2023
mergify bot pushed a commit that referenced this pull request Nov 30, 2023
mergify bot added a commit that referenced this pull request Dec 4, 2023
(cherry picked from commit 537a3c8)

Co-authored-by: Colleen McGinnis <[email protected]>
mergify bot added a commit that referenced this pull request Dec 4, 2023
(cherry picked from commit 537a3c8)

Co-authored-by: Colleen McGinnis <[email protected]>
mergify bot added a commit that referenced this pull request Dec 4, 2023
(cherry picked from commit 537a3c8)

Co-authored-by: Colleen McGinnis <[email protected]>
mergify bot added a commit that referenced this pull request Dec 4, 2023
(cherry picked from commit 537a3c8)

Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.8 Automated backport with mergify backport-8.9 Automated backport with mergify backport-8.10 Automated backport with mergify backport-8.11 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[APM] Document custom field mappings
4 participants