grafana-toolbox / grafana-wtf

Grep through all Grafana entities in the spirit of git-wtf.
GNU Affero General Public License v3.0
138 stars 12 forks source link

find command | return the relevant panel #117

Open interfan7 opened 5 months ago

interfan7 commented 5 months ago

In our case there are abundance of panels, and many dashboards.

When we insert a query as find command argument, we can discover dashboards. This is better than nothing, but not much helpful, especially as users already have a good idea which dashboard to look at. It's the panels that are the biggest pain in searching where a given query is defined.

amotl commented 4 months ago

Hi Leonid,

thank you for writing in. We hear you, and we will see what we might be able to do on another development iteration. If you see some change to improve, patches are always welcome.

With kind regards, Andreas.

amotl commented 3 months ago

Dear Leonid,

we just took a closer look into your feature request.

When we insert a query as find command argument, we can discover dashboards. [However,] it's the panels that are the biggest pain in searching where a given query is defined.

Running that command on play.grafana.org, using a recent version of grafana-wtf,

export GRAFANA_URL=https://play.grafana.org
grafana-wtf find influxdb

will sure enough yield tons of output, but can also be used as a canonical example to demonstrate it seems to work reasonably well? This is a "panel" item you can observe in the list of search results, including a direct link to the relevant panel in bright white, and the details where the search term matches, highlighted in bright yellow.

image

Please let us know how this feature detail could be improved to fit your needs.

With kind regards, Andreas.

amotl commented 1 month ago

Dear Leonid,

may we humbly ask you to have a look at our most recent reply, and re-evaluate what you would like to see improved on this matter?

Our example aims to demonstrate that indeed panels can be discovered by searching for a string. Maybe we are missing important details, or some panel data is not considered for search, yet. Please educate us so we can improve grafana-wtf correspondingly.

Maybe the "Matches" output section could be improved, by displaying the title of the relevant panel, for example?

With kind regards, Andreas.