Dashboard description - is it used anywhere?

  • What Grafana version and what operating system are you using?
    Grafana v8.1.3 (a61f38238c)

  • What are you trying to achieve?
    I would like to see Dashboard descriptions in “Dashboards” → “Manage” and in panel “Dashboard list”.

  • How are you trying to achieve it?
    There is field “Description” in “Dashboard settings” → “General”. I’ve filled it up.

  • What happened?
    Provided description isn’t displayed anywhere.

  • What did you expect to happen?
    I’ve expected the description will be part of item in dashboard list or will pop’up after mouse over

  • Can you copy/paste the configuration(s) that you are having problems with?

  • Did you receive any errors in the Grafana UI or in related logs? If so, please tell us exactly what they were.

  • Did you follow any online instructions? If so, what is the URL?
    I haven’t found.

Hi @grawiku

thanks for starting this topic. Two things: the description appears in the dashboard JSON. Try this:
curl https://play.grafana.org/api/dashboards/uid/000000014 | jq .dashboard.description

And then try it with your own dashboard, replacing the url and uid.

As far as your desire to see the description on the dashboard manager and dashboard list plugin: I think that’s a fantastic idea.

So the best way to get the teams to pick up a community feature request is to start start a discussion in the grafana/grafana repo. Highly upvoted discussions will get traction and picked up by the squads. Recommend you start a discussion and get that going–this is a great idea and shouldn’t be too hard to implement.

This topic was automatically closed after 365 days. New replies are no longer allowed.