public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Dashboard V0->V1 Migration: Schema migration v41 (#100554)

Browse Source
This commit is contained in:
Ivan Ortega Alba
2025-02-13 08:19:51 +01:00
committed by GitHub
parent 0a88cb528a
commit 2b2b19478a
23 changed files with 629 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/apis/dashboard/migration/schemaversion/migrations.go
+2 -1
View File
@@ -6,7 +6,7 @@ type SchemaVersionMigrationFunc func(map[string]interface{}) error
const (
MINIUM_VERSION = 36
LATEST_VERSION = 40
LATEST_VERSION = 41
)
var Migrations = map[int]SchemaVersionMigrationFunc{
@@ -14,6 +14,7 @@ var Migrations = map[int]SchemaVersionMigrationFunc{
38: V38,
39: V39,
40: V40,
41: V41,
}
func GetSchemaVersion(dash map[string]interface{}) int {
pkg/apis/dashboard/migration/schemaversion/v41.go
+11
View File
@@ -0,0 +1,11 @@
package schemaversion
func V41(dash map[string]interface{}) error {
dash["schemaVersion"] = int(41)
if timepicker, ok := dash["timepicker"].(map[string]interface{}); ok {
// time_options is a legacy property that was not used since grafana version 5
// therefore deprecating this property from the schema
delete(timepicker, "time_options")
}
return nil
}
pkg/apis/dashboard/migration/schemaversion/v41_test.go
+38
View File
@@ -0,0 +1,38 @@
package schemaversion_test
import (
"testing"
"github.com/grafana/grafana/pkg/apis/dashboard/migration/schemaversion"
)
func TestV41(t *testing.T) {
tests := []migrationTestCase{
{
name: "time_options is removed",
input: map[string]interface{}{
"title": "Test Dashboard",
"timepicker": map[string]interface{}{
"time_options": []string{"1m", "5m", "15m", "1h", "6h", "12h", "24h"},
},
},
expected: map[string]interface{}{
"title": "Test Dashboard",
"schemaVersion": 41,
"timepicker": map[string]interface{}{},
},
},
{
name: "timepicker is not set",
input: map[string]interface{}{
"title": "Test Dashboard",
},
expected: map[string]interface{}{
"title": "Test Dashboard",
"schemaVersion": 41,
},
},
}
runMigrationTests(t, tests, schemaversion.V41)
}
pkg/apis/dashboard/migration/testdata/input/36.legend_normalization.json
Vendored
+3 -1
View File
@@ -115,7 +115,9 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/input/37.timeseries_table_display_mode.json
Vendored
+3 -1
View File
@@ -352,7 +352,9 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/input/38.transform_timeseries_table.json
Vendored
+3 -1
View File
@@ -145,7 +145,9 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/input/39.refresh_true.json
Vendored
+3 -1
View File
@@ -124,7 +124,9 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/input/40.time_picker_time_options.json
Vendored
+136
View File
@@ -0,0 +1,136 @@
{
"annotations": {
"list": [
{
"builtIn": 1,
"datasource": {
"type": "grafana",
"uid": "-- Grafana --"
},
"enable": true,
"hide": true,
"iconColor": "rgba(0, 211, 255, 1)",
"name": "Annotations & Alerts",
"type": "dashboard"
}
]
},
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"links": [],
"panels": [
{
"datasource": {
"type": "datasource",
"uid": "grafana"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"barWidthFactor": 0.6,
"drawStyle": "line",
"fillOpacity": 0,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "linear",
"lineWidth": 1,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "auto",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
},
{
"color": "red",
"value": 80
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 0
},
"id": 1,
"options": {
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"hideZeros": false,
"mode": "single",
"sort": "none"
}
},
"pluginVersion": "11.5.0-81438",
"targets": [
{
"datasource": {
"type": "datasource",
"uid": "grafana"
},
"queryType": "randomWalk",
"refId": "A"
}
],
"title": "Panel Title",
"type": "timeseries"
}
],
"preload": false,
"tags": [],
"templating": {
"list": []
},
"time": {
"from": "now-6h",
"to": "now"
},
"timepicker": {
"time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
"weekStart": "",
"refresh": "",
"schemaVersion": 40
}
pkg/apis/dashboard/migration/testdata/output/36.legend_normalization.37.json
Vendored
+13 -1
View File
@@ -124,7 +124,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/36.legend_normalization.38.json
Vendored
+13 -1
View File
@@ -124,7 +124,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/36.legend_normalization.39.json
Vendored
+13 -1
View File
@@ -124,7 +124,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/36.legend_normalization.40.json
Vendored
+13 -1
View File
@@ -124,7 +124,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/36.legend_normalization.41.json
Vendored
+132
View File
@@ -0,0 +1,132 @@
{
"annotations": {
"list": [
{
"builtIn": 1,
"datasource": {
"type": "grafana",
"uid": "-- Grafana --"
},
"enable": true,
"hide": true,
"iconColor": "rgba(0, 211, 255, 1)",
"name": "Annotations \u0026 Alerts",
"type": "dashboard"
}
]
},
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"links": [],
"panels": [
{
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 0
},
"id": 1,
"options": {},
"title": "No Legend Config",
"type": "graph"
},
{
"gridPos": {
"h": 8,
"w": 12,
"x": 12,
"y": 0
},
"id": 2,
"options": {
"legend": {
"displayMode": "list",
"showLegend": true
}
},
"title": "Boolean Legend True"
},
{
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 8
},
"id": 3,
"options": {
"legend": {
"displayMode": "list",
"showLegend": false
}
},
"title": "Boolean Legend False"
},
{
"gridPos": {
"h": 8,
"w": 12,
"x": 12,
"y": 8
},
"id": 4,
"options": {
"legend": {
"displayMode": "list",
"showLegend": false
}
},
"title": "Hidden DisplayMode"
},
{
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 16
},
"id": 5,
"options": {
"legend": {
"displayMode": "list",
"showLegend": false
}
},
"title": "ShowLegend False"
},
{
"gridPos": {
"h": 8,
"w": 12,
"x": 12,
"y": 16
},
"id": 6,
"options": {
"legend": {
"displayMode": "table",
"showLegend": true
}
},
"title": "Visible Legend"
}
],
"preload": false,
"refresh": "",
"schemaVersion": 41,
"tags": [],
"templating": {
"list": []
},
"time": {
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
"weekStart": ""
}
pkg/apis/dashboard/migration/testdata/output/37.timeseries_table_display_mode.38.json
Vendored
+13 -1
View File
@@ -367,7 +367,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/37.timeseries_table_display_mode.39.json
Vendored
+13 -1
View File
@@ -367,7 +367,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/37.timeseries_table_display_mode.40.json
Vendored
+13 -1
View File
@@ -367,7 +367,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/37.timeseries_table_display_mode.37.json → pkg/apis/dashboard/migration/testdata/output/37.timeseries_table_display_mode.41.json
Vendored
+25 -8
View File
@@ -31,7 +31,10 @@
"mode": "palette-classic"
},
"custom": {
"displayMode": "basic"
"cellOptions": {
"mode": "basic",
"type": "gauge"
}
},
"mappings": [],
"thresholds": {
@@ -84,7 +87,10 @@
"mode": "palette-classic"
},
"custom": {
"displayMode": "gradient-gauge"
"cellOptions": {
"mode": "gradient",
"type": "gauge"
}
},
"mappings": [],
"thresholds": {
@@ -137,7 +143,10 @@
"mode": "palette-classic"
},
"custom": {
"displayMode": "lcd-gauge"
"cellOptions": {
"mode": "lcd",
"type": "gauge"
}
},
"mappings": [],
"thresholds": {
@@ -190,7 +199,10 @@
"mode": "palette-classic"
},
"custom": {
"displayMode": "color-background"
"cellOptions": {
"mode": "gradient",
"type": "color-background"
}
},
"mappings": [],
"thresholds": {
@@ -243,7 +255,10 @@
"mode": "palette-classic"
},
"custom": {
"displayMode": "color-background-solid"
"cellOptions": {
"mode": "basic",
"type": "color-background"
}
},
"mappings": [],
"thresholds": {
@@ -296,7 +311,9 @@
"mode": "palette-classic"
},
"custom": {
"displayMode": "some-other-mode"
"cellOptions": {
"type": "some-other-mode"
}
},
"mappings": [],
"thresholds": {
@@ -340,8 +357,8 @@
}
],
"preload": false,
"refresh": true,
"schemaVersion": 37,
"refresh": "",
"schemaVersion": 41,
"tags": [],
"templating": {
"list": []
pkg/apis/dashboard/migration/testdata/output/38.transform_timeseries_table.39.json
Vendored
+13 -1
View File
@@ -147,7 +147,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/38.transform_timeseries_table.40.json
Vendored
+13 -1
View File
@@ -147,7 +147,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/38.transform_timeseries_table.38.json → pkg/apis/dashboard/migration/testdata/output/38.transform_timeseries_table.41.json
Vendored
+7 -5
View File
@@ -124,9 +124,11 @@
{
"id": "timeSeriesTable",
"options": {
"refIdToStat": {
"A": "mean",
"B": "max"
"A": {
"stat": "mean"
},
"B": {
"stat": "max"
}
}
}
@@ -135,8 +137,8 @@
}
],
"preload": false,
"refresh": true,
"schemaVersion": 38,
"refresh": "",
"schemaVersion": 41,
"tags": [],
"templating": {
"list": []
pkg/apis/dashboard/migration/testdata/output/39.refresh_true.40.json
Vendored
+13 -1
View File
@@ -126,7 +126,19 @@
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timepicker": {
"time_options": [
"5m",
"15m",
"1h",
"6h",
"12h",
"24h",
"2d",
"7d",
"30d"
]
},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
pkg/apis/dashboard/migration/testdata/output/39.refresh_true.39.json → pkg/apis/dashboard/migration/testdata/output/39.refresh_true.41.json
Vendored
+2 -2
View File
@@ -116,8 +116,8 @@
}
],
"preload": false,
"refresh": true,
"schemaVersion": 39,
"refresh": "",
"schemaVersion": 41,
"tags": [],
"templating": {
"list": []
pkg/apis/dashboard/migration/testdata/output/40.time_picker_time_options.41.json
Vendored
+134
View File
@@ -0,0 +1,134 @@
{
"annotations": {
"list": [
{
"builtIn": 1,
"datasource": {
"type": "grafana",
"uid": "-- Grafana --"
},
"enable": true,
"hide": true,
"iconColor": "rgba(0, 211, 255, 1)",
"name": "Annotations \u0026 Alerts",
"type": "dashboard"
}
]
},
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"links": [],
"panels": [
{
"datasource": {
"type": "datasource",
"uid": "grafana"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisBorderShow": false,
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"barWidthFactor": 0.6,
"drawStyle": "line",
"fillOpacity": 0,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"insertNulls": false,
"lineInterpolation": "linear",
"lineWidth": 1,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "auto",
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
},
{
"color": "red",
"value": 80
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 0
},
"id": 1,
"options": {
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"hideZeros": false,
"mode": "single",
"sort": "none"
}
},
"pluginVersion": "11.5.0-81438",
"targets": [
{
"datasource": {
"type": "datasource",
"uid": "grafana"
},
"queryType": "randomWalk",
"refId": "A"
}
],
"title": "Panel Title",
"type": "timeseries"
}
],
"preload": false,
"refresh": "",
"schemaVersion": 41,
"tags": [],
"templating": {
"list": []
},
"time": {
"from": "now-6h",
"to": "now"
},
"timepicker": {},
"timezone": "utc",
"title": "New dashboard",
"version": 0,
"weekStart": ""
}