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

Add Dashboards for Metricbeat #5451

Closed
3 of 23 tasks
monicasarbu opened this issue Oct 26, 2017 · 22 comments
Closed
3 of 23 tasks

Add Dashboards for Metricbeat #5451

monicasarbu opened this issue Oct 26, 2017 · 22 comments
Labels
:Dashboards help wanted Indicates that a maintainer wants help on an issue or pull request meta

Comments

@monicasarbu
Copy link
Contributor

monicasarbu commented Oct 26, 2017

Missing dashboards

The following Metricbeat modules are missing a dashboard:

The following Metricbeat modules have dashboards, but need to be transformed to use TSVB visualizations:

  • golang
  • mysql

Note that some modules have ? as they are too generic, and I am not sure if we can build a useful dashboard for them.

Naming convention

There is a naming convention for the dashboards, visualizations, searches across the dashboards provided by Logstash and Beats starting with 6.0 release.

Dashboards are named like this: "[Filebeat Nginx] Access logs"
Visualizations and searches are named like this: "Top processes [Filebeat Nginx]"

Documentation
https://www.elastic.co/guide/en/beats/devguide/master/new-dashboards.html

FAQ
Q: What Kibana should we use for creating the dashboards?
A: I would say the latest release.

Q: The saved dashboards objects are different for Kibana 5.x than for 6.x (see the 5.x and 6.x directories under _meta/kibana). Should we save the dashboards only for the Kibana 6.x releases or 5.x too?
A: I would say to start with 6.x first and leave 5.x for later.

Q: How to subscribe that you are building the dashboards for a module?
A: Just add your name near the module to make sure we are not duplicating effort.

Q: Are we accepting community contributions?
A: Yes, we are happy to get community contributions.

@monicasarbu monicasarbu added :Dashboards meta help wanted Indicates that a maintainer wants help on an issue or pull request labels Oct 26, 2017
@ruflin
Copy link
Contributor

ruflin commented Nov 6, 2017

@monicasarbu For the naming convention: I'm curious why the one used for Dashboards is different from the for Visualisations? First one starting with [ ... ] and the other one ending with [ ... ] ?

@monicasarbu
Copy link
Contributor Author

monicasarbu commented Nov 6, 2017

@acchen97 came with this proposal. I guess it's because for the dashboards is important first to see the module from where it belongs. In Kibana, only the first x characters are displayed in the title of each visualization, so it's important for the user to see the description of the visualization and not the module from where it belongs.

@loekvangool
Copy link

loekvangool commented Apr 10, 2018

@monicasarbu there seems to be a dashboard shipped with Kibana now.

@ruflin
Copy link
Contributor

ruflin commented Apr 11, 2018

To get a better picture on the current state of which modules have a dashboard, we auto generate it now for our docs: https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-modules.html

@loekvangool
Copy link

Forgot something important, it seems that there is now an nginx dashboard so this can be closed?

@ruflin
Copy link
Contributor

ruflin commented Apr 11, 2018

@monicasarbu I'm thinking to close this meta issue as this issue had not really lead to the community contributions, we are now tracking in the docs automatically which modules have dashboards and in general adding dashboards is part of making the modules GA.

For the details on the naming we should add it to the dev guide.

@jsoriano
Copy link
Member

Haproxy dashboards added in #6934

@monicasarbu
Copy link
Contributor Author

@ruflin Feel free to close this issue.

@ruflin ruflin closed this as completed Apr 26, 2018
@anthonyserious
Copy link

I would be open to contributing a kafka dashboard, since I probably need to brew one up anyway. I scanned over open issues and don't think anyone's created one. Just don't want to duplicate effort if there's already work under way.

@ruflin
Copy link
Contributor

ruflin commented Jul 19, 2018

@anthonyserious A dashboard would definitively be welcome.

@tollgen
Copy link

tollgen commented Jul 19, 2018

Any progress on a dashboard for postgresql or anyone have a working one?

@anthonyserious
Copy link

@ruflin 👍 No promises on a timeline, but if it happens it'll be in the next few weeks.

@ruflin
Copy link
Contributor

ruflin commented Jul 19, 2018

@tollgen No progress on the postgres dashboard so far.

@anthonyserious Of course, let us know if we can help in any way.

@gingerwizard
Copy link

@anthonyserious i'm looking at adding a dashboard for kafka. Unfortunately, due to the current fields its going to be difficult to produce something compelling. More specifically:

  1. The stats are split across two metricsets - consumergroups and partitions. These do not have consistent fields e.g. topic, partition on which to drill down. @jsoriano is aware of this and this should be quick fix.
  2. Most users are probably interested in consumer lag. The consumergroup docs have no indication of the max offset of the partition from which they are consuming - any calculation will need the partition docs therefore. This is going to produce very unreliable metrics OR result in complex kibana queries which might not perform on high partition counts. I considered something like sum(consumergroup)-sum(parition offsets) by topic. This is subject to bucketing issues however and can result in poor counts. Maybe we could give an overall indication of lag instead of a precise count.

I will host any initial dashboard on staging.demo.elastic.co for comment.

@anthonyserious
Copy link

@gingerwizard sounds good to me. I haven't had the opportunity to start anything yet, and I haven't even looked at what fields are available. Thanks for doing this!

@gingerwizard
Copy link

This needs fields that currently aren't available in the module. @jsoriano is looking at extending the module to add these fields.

@jsoriano
Copy link
Member

PR with the changes on fields #7767

@jsoriano
Copy link
Member

PR with the Kafka dashboard merged into master #8457

@sayden
Copy link
Contributor

sayden commented Feb 11, 2019

Re-issued here: #10594

@samirsss
Copy link

Thanks for the awesome work. Metricbeats has been really helpful to us for monitoring the resources. I'd really like to see some updates for the Postgresql Dashboard.

@jsoriano
Copy link
Member

jsoriano commented Apr 17, 2019

@samirsss are you activelly using the Postgresql dashboard? It'd be great if you could open a new issue with whatever you think we can improve there. As a user of it your feedback will be really valuable! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Dashboards help wanted Indicates that a maintainer wants help on an issue or pull request meta
Projects
None yet
Development

No branches or pull requests

9 participants