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 the ES output presets doc #869

Closed
4 tasks done
jlind23 opened this issue Jan 30, 2024 · 7 comments
Closed
4 tasks done

Update the ES output presets doc #869

jlind23 opened this issue Jan 30, 2024 · 7 comments
Assignees

Comments

@jlind23
Copy link
Contributor

jlind23 commented Jan 30, 2024

When we introduced the ES output presets in Kibana we made some mistakes on the settings name.
The related issue is: elastic/kibana#175892

We should update the docs to reflect these changes.
In the meantime we need to improve the docs on a couple of other items:

  • We need to explicitly state that presets values prevail over any other settings.

  • If users want to change one setting of a preset they will have to fallback on the custom mode and manually add all values to the custom yaml box.
    One workflow offered by @kpollich is :

  • Goal: use Balanced preset with one minor value changed

    • Go to docs -> Copy balanced preset YML -> Paste into UI -> Automatically assigns Custom preset -> Change the given value
    • Context: we want presets to be "good enough" - don't want to promote overriding them. Presets are not "templates".
  • This blog post need to be updated - https://www.elastic.co/blog/using-elastic-agent-performance-presets-in-8-12

  • This tab needs to be updated - https://www.elastic.co/guide/en/fleet/current/es-output-settings.html

These changes should be backported to 8.12 branch and will land in one of the 8.12 patch release.

@kilfoyle
Copy link
Contributor

kilfoyle commented Jan 30, 2024

Thanks for opening this @jlind23!

This PR includes the term fixes and the workaround steps.

I wasn't involved with the blog though. @nimarezainia can you please help with that part?

@nimarezainia
Copy link
Contributor

@jlind23 I can change the blog. What exactly is the concern? in the blog we do say what the default values are and the fields that were changed. The naming of those fields are not configurations rather just that, a name. Is that what you are asking to change? for example change "compression" to "compression_level"?

regarding the custom presets, I read the blog again. I feel like it's fine as far as the description goes. Of course points back t the public docs for more detail so that needs to be crisp and clear.

Let me know where you think the blog needs to be changed. thanks.

@jlind23
Copy link
Contributor Author

jlind23 commented Jan 31, 2024

Spoke with @nimarezainia this morning about this and gave him the pointers to the right settings names.

@kilfoyle
Copy link
Contributor

The docs are fixed up now, via #870

@jlind23
Copy link
Contributor Author

jlind23 commented Jan 31, 2024

@kilfoyle Can I close this issue as done then?

@kilfoyle
Copy link
Contributor

kilfoyle commented Jan 31, 2024

@jlind23 Yes please. The only remaining piece is the blog, which I see Nima is looking after. So it's good to close. Thanks!

@nimarezainia
Copy link
Contributor

blog is updated now. thanks folks.

@kilfoyle kilfoyle closed this as completed Feb 1, 2024
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

3 participants