search

supabase / supabase-grafana

Observability for your Supabase project, using Prometheus/Grafana
https://supabase.com
MIT License
184 stars 37 forks source link

replace all instances of deprecated angular graph plugin with timeseries plugin #29

Open jpetrucciani opened 1 month ago

jpetrucciani commented 1 month ago

What kind of change does this PR introduce?

Newer versions of Grafana (from 9) have deprecated the use of the plugins that use Angular (deprecation notice here), and it has been fully removed as of Grafana 11. This PR updates the included dashboard.json spec to convert legacy graph plugins to use the newer builtin timeseries plugin, while maintaining the existing style/formatting

What is the current behavior?

Use of the included dashboard on versions of Grafana 9+ will show warnings on each of the graph plugins, and starting with Grafana 11, will stop working

What is the new behavior?

All of the affected plugins have been converted to the builtin timeseries plugin

Additional context

I've tested this on one of my existing Grafana 10 installs, and the dashboard looks as it should, but removes the alerts/warnings for deprecated plugin use! Please try out installing this via the json spec - I've been testing it by fully removing and re-adding by this json spec alone.

This was decently time consuming to do, so I wanted to be sure to raise this in case it saves other people some tedious work!

darora commented 1 month ago

Thanks for opening this. I think we're going to need to overhaul this repo a little.

For context, the dashboard spec in this repo was based off the specs we use internally, though unfortunately whatever modifications were made for this repo seem to have been made by hand rather than using a script.

I think the path forward for this repo is likely for the modifications to be captured in some sort of automated script, so that we can keep this repo continually updated with both upstream and our own changes.

It sounds like for now you're not blocked on these changes being merged - lmk if that's not the case.

jpetrucciani commented 1 month ago

Apologies! I did not realize that this was being formed/pulled from elsewhere. For clarification - does this repo already diverge from the upstream that you've linked to (before my changes)? Or should I look at raising a PR to the above to make the changes there first (if they're even needed)?

Definitely agree that the right path forward is probably to get some flow going to generate this from the upstream(s).

If it's already diverged from the upstream (before my change) and we're okay merging this as is (after a quick sanity test), I think that may be beneficial for supabase users - since this repo is linked to from the supabase docs