Merge pull request #92 from K-Phoen/panel-description

Panel description
K-Phoen · Mar 22, 2021 · b73c5fd · b73c5fd
2 parents 9b0fcba + 2560cce
commit b73c5fd
Show file tree

Hide file tree

Showing 18 changed files with 116 additions and 5 deletions.
diff --git a/decoder/dashboard_test.go b/decoder/dashboard_test.go
@@ -582,6 +582,7 @@ rows:
   - name: Test row
     panels:
       - text:
+          description: Some description
           height: 400px
           span: 6
           transparent: true
@@ -634,6 +635,7 @@ rows:
 					"height": "400px",
 					"styles": null,
 					"title": "Some markdown?",
+					"description": "Some description",
 					"transparent": true,
 					"options": {
 						"content": "",
@@ -709,6 +711,7 @@ rows:
     panels:
       - graph:
           title: Heap allocations
+          description: Some description
           height: 400px
           span: 4
           transparent: true
@@ -774,6 +777,7 @@ rows:
 					"span": 4,
 					"fill": 1,
 					"title": "Heap allocations",
+					"description": "Some description",
 					"aliasColors": {},
 					"alert": {
 						"conditions": [
@@ -1169,6 +1173,7 @@ rows:
     panels:
       - single_stat:
           title: Heap Allocations
+          description: Some description
           height: 400px
           span: 4
           transparent: true
@@ -1217,6 +1222,7 @@ rows:
 					"span": 4,
 					"height": "400px",
 					"title": "Heap Allocations",
+					"description": "Some description",
 					"transparent": true,
 					"type": "singlestat",
 					"colors": [
@@ -1297,6 +1303,7 @@ rows:
     panels:
       - table:
           title: Threads
+          description: Threads here
           height: 400px
           span: 4
           transparent: true
@@ -1345,6 +1352,7 @@ rows:
 					"renderer": "flot",
 					"span": 4,
 					"title": "Threads",
+					"description": "Threads here",
 					"transparent": true,
 					"type": "table",
 					"columns": [
@@ -1406,6 +1414,7 @@ rows:
     panels:
     - heatmap:
         title: Reconciliation Performance
+        description: Does it perform?
         span: 12
         datasource: $datasource
         data_format: time_series_buckets
@@ -1457,6 +1466,7 @@ rows:
 					"renderer": "flot",
 					"span": 12,
 					"title": "Reconciliation Performance",
+					"description": "Does it perform?",
 					"transparent": false,
 					"type": "heatmap",
 					"targets": [

diff --git a/decoder/graph.go b/decoder/graph.go
@@ -15,6 +15,7 @@ var ErrInvalidLegendAttribute = fmt.Errorf("invalid legend attribute")
 
 type DashboardGraph struct {
 	Title         string
+	Description   string  `yaml:",omitempty"`
 	Span          float32 `yaml:",omitempty"`
 	Height        string  `yaml:",omitempty"`
 	Transparent   bool    `yaml:",omitempty"`
@@ -29,6 +30,9 @@ type DashboardGraph struct {
 func (graphPanel DashboardGraph) toOption() (row.Option, error) {
 	opts := []graph.Option{}
 
+	if graphPanel.Description != "" {
+		opts = append(opts, graph.Description(graphPanel.Description))
+	}
 	if graphPanel.Span != 0 {
 		opts = append(opts, graph.Span(graphPanel.Span))
 	}

diff --git a/decoder/heatmap.go b/decoder/heatmap.go
@@ -12,6 +12,7 @@ var ErrInvalidDataFormat = fmt.Errorf("invalid data format")
 
 type DashboardHeatmap struct {
 	Title           string
+	Description     string  `yaml:",omitempty"`
 	Span            float32 `yaml:",omitempty"`
 	Height          string  `yaml:",omitempty"`
 	Transparent     bool    `yaml:",omitempty"`
@@ -53,6 +54,9 @@ func (tooltip *HeatmapTooltip) toOptions() []heatmap.Option {
 func (heatmapPanel DashboardHeatmap) toOption() (row.Option, error) {
 	opts := []heatmap.Option{}
 
+	if heatmapPanel.Description != "" {
+		opts = append(opts, heatmap.Description(heatmapPanel.Description))
+	}
 	if heatmapPanel.Span != 0 {
 		opts = append(opts, heatmap.Span(heatmapPanel.Span))
 	}

diff --git a/decoder/heatmap_test.go b/decoder/heatmap_test.go
@@ -10,6 +10,7 @@ func TestHeatmapCanBeDecoded(t *testing.T) {
 	req := require.New(t)
 
 	panel := DashboardHeatmap{
+		Description:     "awesome description",
 		Span:            12,
 		Height:          "300px",
 		Transparent:     true,

diff --git a/decoder/row.go b/decoder/row.go
@@ -7,7 +7,7 @@ import (
 
 type DashboardRow struct {
 	Name   string
-	Repeat string `yaml:"repeat_for"`
+	Repeat string `yaml:"repeat_for,omitempty"`
 	Panels []DashboardPanel
 }
 

diff --git a/decoder/singlestat.go b/decoder/singlestat.go
@@ -13,6 +13,7 @@ var ErrInvalidSingleStatValueType = fmt.Errorf("invalid single stat value type")
 
 type DashboardSingleStat struct {
 	Title       string
+	Description string  `yaml:",omitempty"`
 	Span        float32 `yaml:",omitempty"`
 	Height      string  `yaml:",omitempty"`
 	Transparent bool    `yaml:",omitempty"`
@@ -29,6 +30,9 @@ type DashboardSingleStat struct {
 func (singleStatPanel DashboardSingleStat) toOption() (row.Option, error) {
 	opts := []singlestat.Option{}
 
+	if singleStatPanel.Description != "" {
+		opts = append(opts, singlestat.Description(singleStatPanel.Description))
+	}
 	if singleStatPanel.Span != 0 {
 		opts = append(opts, singlestat.Span(singleStatPanel.Span))
 	}

diff --git a/decoder/table.go b/decoder/table.go
@@ -7,6 +7,7 @@ import (
 
 type DashboardTable struct {
 	Title                  string
+	Description            string  `yaml:",omitempty"`
 	Span                   float32 `yaml:",omitempty"`
 	Height                 string  `yaml:",omitempty"`
 	Transparent            bool    `yaml:",omitempty"`
@@ -19,6 +20,9 @@ type DashboardTable struct {
 func (tablePanel DashboardTable) toOption() (row.Option, error) {
 	opts := []table.Option{}
 
+	if tablePanel.Description != "" {
+		opts = append(opts, table.Description(tablePanel.Description))
+	}
 	if tablePanel.Span != 0 {
 		opts = append(opts, table.Span(tablePanel.Span))
 	}

diff --git a/decoder/text.go b/decoder/text.go
@@ -7,6 +7,7 @@ import (
 
 type DashboardText struct {
 	Title       string
+	Description string  `yaml:",omitempty"`
 	Span        float32 `yaml:",omitempty"`
 	Height      string  `yaml:",omitempty"`
 	Transparent bool    `yaml:",omitempty"`
@@ -17,6 +18,9 @@ type DashboardText struct {
 func (textPanel DashboardText) toOption() row.Option {
 	opts := []text.Option{}
 
+	if textPanel.Description != "" {
+		opts = append(opts, text.Description(textPanel.Description))
+	}
 	if textPanel.Span != 0 {
 		opts = append(opts, text.Span(textPanel.Span))
 	}

diff --git a/graph/graph.go b/graph/graph.go
@@ -157,6 +157,13 @@ func Height(height string) Option {
 	}
 }
 
+// Description annotates the current visualization with a human-readable description.
+func Description(content string) Option {
+	return func(graph *Graph) {
+		graph.Builder.Description = &content
+	}
+}
+
 // Transparent makes the background transparent.
 func Transparent() Option {
 	return func(graph *Graph) {

diff --git a/graph/graph_test.go b/graph/graph_test.go
@@ -52,14 +52,23 @@ func TestGraphPanelHeightCanBeConfigured(t *testing.T) {
 	req.Equal("400px", *panel.Builder.Height)
 }
 
-func TestTextPanelBackgroundCanBeTransparent(t *testing.T) {
+func TestGraphPanelBackgroundCanBeTransparent(t *testing.T) {
 	req := require.New(t)
 
 	panel := New("", Transparent())
 
 	req.True(panel.Builder.Transparent)
 }
 
+func TestGraphPanelDescriptionCanBeSet(t *testing.T) {
+	req := require.New(t)
+
+	panel := New("", Description("lala"))
+
+	req.NotNil(panel.Builder.Description)
+	req.Equal("lala", *panel.Builder.Description)
+}
+
 func TestGraphPanelDataSourceCanBeConfigured(t *testing.T) {
 	req := require.New(t)
 

diff --git a/heatmap/heatmap.go b/heatmap/heatmap.go
@@ -158,6 +158,13 @@ func Height(height string) Option {
 	}
 }
 
+// Description annotates the current visualization with a human-readable description.
+func Description(content string) Option {
+	return func(heatmap *Heatmap) {
+		heatmap.Builder.Description = &content
+	}
+}
+
 // Transparent makes the background transparent.
 func Transparent() Option {
 	return func(heatmap *Heatmap) {

diff --git a/heatmap/heatmap_test.go b/heatmap/heatmap_test.go
@@ -51,14 +51,23 @@ func TestHeatmapPanelHeightCanBeConfigured(t *testing.T) {
 	req.Equal("400px", *panel.Builder.Height)
 }
 
-func TestTextPanelBackgroundCanBeTransparent(t *testing.T) {
+func TestHeatmapPanelBackgroundCanBeTransparent(t *testing.T) {
 	req := require.New(t)
 
 	panel := New("", Transparent())
 
 	req.True(panel.Builder.Transparent)
 }
 
+func TestHeatmapPanelDescriptionCanBeSet(t *testing.T) {
+	req := require.New(t)
+
+	panel := New("", Description("lala"))
+
+	req.NotNil(panel.Builder.Description)
+	req.Equal("lala", *panel.Builder.Description)
+}
+
 func TestHeatmapPanelDataSourceCanBeConfigured(t *testing.T) {
 	req := require.New(t)
 

diff --git a/singlestat/singlestat.go b/singlestat/singlestat.go
@@ -169,6 +169,13 @@ func Height(height string) Option {
 	}
 }
 
+// Description annotates the current visualization with a human-readable description.
+func Description(content string) Option {
+	return func(singleStat *SingleStat) {
+		singleStat.Builder.Description = &content
+	}
+}
+
 // Transparent makes the background transparent.
 func Transparent() Option {
 	return func(singleStat *SingleStat) {

diff --git a/singlestat/singlestat_test.go b/singlestat/singlestat_test.go
@@ -51,14 +51,23 @@ func TestSingleStatPanelHeightCanBeConfigured(t *testing.T) {
 	req.Equal("400px", *panel.Builder.Height)
 }
 
-func TestTextPanelBackgroundCanBeTransparent(t *testing.T) {
+func TestSingleStatPanelBackgroundCanBeTransparent(t *testing.T) {
 	req := require.New(t)
 
 	panel := New("", Transparent())
 
 	req.True(panel.Builder.Transparent)
 }
 
+func TestSingleStatPanelDescriptionCanBeSet(t *testing.T) {
+	req := require.New(t)
+
+	panel := New("", Description("lala"))
+
+	req.NotNil(panel.Builder.Description)
+	req.Equal("lala", *panel.Builder.Description)
+}
+
 func TestSingleStatPanelDataSourceCanBeConfigured(t *testing.T) {
 	req := require.New(t)
 

diff --git a/table/table.go b/table/table.go
@@ -169,6 +169,13 @@ func Height(height string) Option {
 	}
 }
 
+// Description annotates the current visualization with a human-readable description.
+func Description(content string) Option {
+	return func(table *Table) {
+		table.Builder.Description = &content
+	}
+}
+
 // Transparent makes the background transparent.
 func Transparent() Option {
 	return func(table *Table) {

diff --git a/table/table_test.go b/table/table_test.go
@@ -114,10 +114,19 @@ func TestDataCanBeTransformedAsTimeSeriesAggregations(t *testing.T) {
 	req.Equal(string(AVG), panel.Builder.TablePanel.Columns[0].Value)
 }
 
-func TestTextPanelBackgroundCanBeTransparent(t *testing.T) {
+func TestTablePanelBackgroundCanBeTransparent(t *testing.T) {
 	req := require.New(t)
 
 	panel := New("", Transparent())
 
 	req.True(panel.Builder.Transparent)
 }
+
+func TestTablePanelDescriptionCanBeSet(t *testing.T) {
+	req := require.New(t)
+
+	panel := New("", Description("lala"))
+
+	req.NotNil(panel.Builder.Description)
+	req.Equal("lala", *panel.Builder.Description)
+}
diff --git a/text/text.go b/text/text.go
@@ -57,6 +57,13 @@ func Height(height string) Option {
 	}
 }
 
+// Description annotates the current visualization with a human-readable description.
+func Description(content string) Option {
+	return func(text *Text) {
+		text.Builder.Description = &content
+	}
+}
+
 // Transparent makes the background transparent.
 func Transparent() Option {
 	return func(text *Text) {

diff --git a/text/text_test.go b/text/text_test.go
@@ -61,3 +61,12 @@ func TestTextPanelBackgroundCanBeTransparent(t *testing.T) {
 
 	req.True(panel.Builder.Transparent)
 }
+
+func TestTextPanelDescriptionCanBeSet(t *testing.T) {
+	req := require.New(t)
+
+	panel := New("", Description("lala"))
+
+	req.NotNil(panel.Builder.Description)
+	req.Equal("lala", *panel.Builder.Description)
+}