cloudfoundry / cloudfoundry/prometheus-boshrelease

[Grafana] Migrate dashboards to new React based Dashboards

Open
#508 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Shell
Stars
120
Forks
175
PR merge metrics
No merged PRs in 30d

Description

Grafana plans to remove the V2 dashboards. Most of it is able to be automated but to prevent having Angular based dashboards that get migrated on each start we should change the way the dashboards work.

In our staging i enabled automatic migrations. As side project I started to clean up dashboards that were auto-migrated, removing/fixing values that are not visualized and "resetting" them to a template. This will take a bit due to the lack of infinite time and manual "visual" inspections so I would welcome any helpers. Furthermore we do not use all dashboards internally so I have no way to verify functionality above "we do not get errors importing them"

To enable the automated migration edit the /var/vcap/jobs/grafana/config/grafana.ini to contain the following:

[feature_toggles]
autoMigrateOldPanels = true

Then export panel json and reset it back to a template for the repo. It will fill out current selections and data sources, which you have to reset.

I will create the first PR for this and plan to finish the bosh panels by end of the week so they can be tested by people that are not me as well.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Grafana configuration at /var/vcap/jobs/grafana/config/grafana.ini and enable autoMigrateOldPanels to inspect the existing dashboards. Export each migrated panel's JSON, then compare its selections and data sources with the repository template. Done means the relevant dashboards import without errors and are cleaned up for the new React-based dashboards.

Written by the indexing model from the issue text.

Assessment

Tech stack
grafana, react
Domain
observability
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.