🚀 grafana: Make more information for alerts available

[tlanfer]

Plugin Name

grafana

🔖 Feature description

The grafana plugin could expose some more information about alerts through the grafanaApi it provides. Some of these would be very useful in the context of backstage, like for alert summary/description and example runbook_urls.

🎤 Context

When displaying alerts for a service its only somewhat useful to see the alert name. And jumping over into grafana can be very confusing, as the grafana UI is not exactly intuitive. I would like to show alerts in backstage, but also provide a summary of "what does this alert mean?!" and maybe even provide links to runbooks on how to handle those situations. Grafana already has this info, i would like for this to be available in backstage.

✌️ Possible Implementation

I already hacked together a rather ugly implementation for this which only works for unified alertings and bravely assumes the first alert instance has the information i need. I then made a simple accordion component to use these annotations, link to grafana and link to runbooks. I plan to have my people just write these runbooks as techdocs, so everythings is right there available in backstage.

I made my own UI component mainly to have something that looks clean and clear, especially if i add more information.

I am not exactly a seasoned typescript dev, but i can put together working code. Nor do i know the processes to get changes merged into backstage. I am willing to learn and create a PR though, if that would help.

👀 Have you spent some time to check if this feature request has been raised before?

• [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• [X] I have read the Code of Conduct

Are you willing to submit PR?

Yes I am willing to submit a PR!

[awanlin]

Hi @tlanfer, sounds good feel free to submit a PR! 🚀

[tlanfer]

Unfortunately i only have very limited opportunity to work on this, but if i find the time i will look into it. I dont have access to a grafana cluster with alerts without unified alerting, so its difficult for me to implement that part. And to be honest, i dont know all that much about the grafana APIs in general, so i can only implement it on a best-guess-see-what-works basis.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.