elastic / beats

:tropical_fish: Beats - Lightweight shippers for Elasticsearch & Logstash
https://www.elastic.co/products/beats
Other
12.18k stars 4.92k forks source link

[DOCS] consistently indicate when a Beats module provides dashboards and visualisations out of the box #36966

Open geekpete opened 1 year ago

geekpete commented 1 year ago

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/
botelastic[bot] commented 2 days ago

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!