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 how to customize index settings and ILM policies for managed apm-server #5988

Closed
simitt opened this issue Aug 20, 2021 · 4 comments
Labels
docs Team:Docs Label for the Observability docs team
Milestone

Comments

@simitt
Copy link
Contributor

simitt commented Aug 20, 2021

By default, an empty custom component template is created per data stream. If users want to change index settings and/or ILM policies they can use these component templates for any customization. Custom templats are not overwritten on upgrade.

  • GET _index_template/<data-stream> to identify the custom component template name (composed_of)
  • GET _component_template/t<custom-component-name> to retrieve custom component template settings
  • PUT _component_template/t<custom-component-name> to update it, for example:
PUT _component_template/traces-apm@custom
{
 "template": {
   "settings": {
     "number_of_shards": 3 
   }
 }
}

Document that default ILM policies might be changed within minor version upgrades. This is not considered a breaking change, but helps to continually improve and adapt the index management to new features and requirements. If users want to avoid any surprises, they are supposed to make use of setting up a custom ILM policy.

@simitt simitt added this to the 7.16 milestone Aug 20, 2021
@zube zube bot added the [zube]: Ready label Aug 20, 2021
@simitt simitt added the Team:Docs Label for the Observability docs team label Dec 17, 2021
@Mpdreamz
Copy link
Member

Should we document this under: https://www.elastic.co/guide/en/apm/guide/current/apm-tune-elasticsearch.html ?

The custom component template names are fixed right? We can just document the PUT _component/template/<name> invocation?

@bmorelli25
Copy link
Member

bmorelli25 commented Jan 19, 2022

@Mpdreamz We have custom ILM docs in that bucket already: https://www.elastic.co/guide/en/apm/guide/8.0/ilm-how-to.html. AFAIK though, the edits to @custom templates have not been fixed to persist through version upgrades, so we may need to remove these docs prior to 8.0.

These are the issues I'm tracking:

We've also paused docs for custom ingest pipelines: elastic/observability-docs#1226.

@simitt
Copy link
Contributor Author

simitt commented Feb 3, 2022

Setting custom ILM policies that are persisted between updates is supposed to be working. elastic/kibana#111197 moved the settings from the index template to the default component template, allowing users to overwrite the settings via the custom component template. This means that users can generate their own ILM policies and set the policy name in the custom component templates settings. This should be persisted between updates.

@bmorelli25
Copy link
Member

bmorelli25 commented Feb 3, 2022

Silvia is right. I misunderstood elastic/kibana#121184.

I'll close this issue as documentation already exists in 7.17+ for custom APM ILM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:Docs Label for the Observability docs team
Projects
None yet
Development

No branches or pull requests

3 participants