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] Clarify elasticsearch module for Stack monitoring #64497

Merged
merged 1 commit into from
Jan 20, 2021

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 2, 2020

Fixes #64486

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/Monitoring)

@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Data Management Meta label for data/management team labels Nov 2, 2020
@chrisronline
Copy link
Contributor

@lcawl Can you add a link to the generated docs when you get a chance?

@lcawl
Copy link
Contributor Author

lcawl commented Nov 3, 2020

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].
Copy link
Contributor

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?

Copy link
Contributor Author

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.

Copy link
Contributor

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:

https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-elasticsearch.html#_usage_for_stack_monitoring_2

This suggests that you either enable xpack.enabled: true or enable the elasticsearch-xpack module. I think @ycombinator might know more.

Copy link
Contributor Author

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!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Monitoring >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.11.0 v7.12.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Metricbeat setup instructions are unclear
7 participants