-
Notifications
You must be signed in to change notification settings - Fork 24.5k
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] Clarify elasticsearch module for Stack monitoring #64497
Conversation
Pinging @elastic/es-docs (>docs) |
Pinging @elastic/es-core-features (:Core/Features/Monitoring) |
@lcawl Can you add a link to the generated docs when you get a chance? |
Alternatively, you can use the {es} module, as described in the | ||
{metricbeat-ref}/metricbeat-module-elasticsearch.html[{es} module usage for {stack} monitoring]. | ||
For more information, refer to | ||
{metricbeat-ref}/metricbeat-module-elasticsearch.html[{es} module]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it weird that we link to the other module here? That seems like a confusing thing for users too. We should either add docs for the -xpack
modules (and maybe we do and I can't find them) or not link at all?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it seems like the -xpack modules aren't documented. I'll follow up on whether that's in the plans and remove the link if not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH I can't remember the history of this content, but I think the -xpack modules were documented originally but caused confusion. Now the docs have a section that mentions monitoring here:
This suggests that you either enable xpack.enabled: true
or enable the elasticsearch-xpack
module. I think @ycombinator might know more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chrisronline We re-added the "Usage for Stack Monitoring" section in the elasticsearch module docs (via elastic/beats#23286) since it didn't seem possible to have separate (duplicate) docs for the elasticsearch-xpack module. If you still think this link is more confusing than helpful and ought to be removed from these instructions, just let me know!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me!
07dcfee
to
f57ebb7
Compare
Fixes #64486