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] consistently indicate when a Beats module provides dashboards and visualisations out of the box #36966

Open
geekpete opened this issue Oct 25, 2023 · 1 comment
Labels
docs Stalled Team:Docs Label for the Observability docs team

Comments

@geekpete
Copy link
Member

Describe the enhancement:

Some modules provide their own Dashboards and Visualisations, some do not.
From the Modules docs, it's not always clear to see if a module provides associated dashboards for the metrics it collects and what the dashboard looks like or include depending on the module.
Some modules do mention they provide dashboards, some don't.

The ask is to have a consistent documentation standard on provided Dashboards across all modules.

HA Proxy dashboards shipped with the Metricbeat module
https://github.com/elastic/beats/tree/v8.10.4/metricbeat/module/haproxy/_meta/kibana/7

but no mention of those dashboards in the Beats module docs:
https://www.elastic.co/guide/en/beats/metricbeat/8.10/metricbeat-module-haproxy.html

(or in the integration docs, needs separate issue):
https://docs.elastic.co/en/integrations/haproxy

Another might be the Apache module, comes with dashboard/visualisations/search:
https://github.com/elastic/beats/tree/v8.10.4/metricbeat/module/apache/_meta/kibana/7

which does document the dashboard with a section and a screenshot:
https://www.elastic.co/guide/en/beats/metricbeat/8.10/metricbeat-module-apache.html

It looks to be about half the modules do provide their own dashboard and it seems 7 modules are missing a mention of their dashboard in docs:

aerospike/_meta/kibana/
apache/_meta/kibana/
ceph/_meta/kibana/
consul/_meta/kibana/
couchbase/_meta/kibana/
couchdb/_meta/kibana/
docker/_meta/kibana/ - no dashboard mentioned in docs
golang/_meta/kibana/ - no dashboard mentioned in docs
haproxy/_meta/kibana/ - no dashboard mentioned in docs
kafka/_meta/kibana/
kubernetes/_meta/kibana/
mongodb/_meta/kibana/ - no dashboard mentioned in docs
mysql/_meta/kibana/
nats/_meta/kibana/
nginx/_meta/kibana/
postgresql/_meta/kibana/
prometheus/_meta/kibana/
rabbitmq/_meta/kibana/ - no dashboard mentioned in docs
redis/_meta/kibana/ - no dashboard mentioned in docs
system/_meta/kibana/
uwsgi/_meta/kibana/
vsphere/_meta/kibana/
windows/_meta/kibana/ - no dashboard mentioned in docs
zookeeper/_meta/kibana/
@geekpete geekpete added docs Team:Docs Label for the Observability docs team labels Oct 25, 2023
@botelastic
Copy link

botelastic bot commented Oct 24, 2024

Hi!
We just realized that we haven't looked into this issue in a while. We're sorry!

We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1.
Thank you for your contribution!

@botelastic botelastic bot added the Stalled label Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Stalled Team:Docs Label for the Observability docs team
Projects
None yet
Development

No branches or pull requests

1 participant