feat: Support DisplayInfo in Panels (#210)

Today, panels created by the provider only support a promql query, but not the DisplayInfo fields.
That means that dashboard panels are hard to read as they are the raw promql and not user friendly strings.
This adds support for DisplayInfo fields in the resource.

Author: brokenpip3

CODEOWNERS

@@ -4,5 +4,8 @@
 # compliance
 *benchmark* @haresh-suresh  @nkraemer-sysdig 
 
+
 # monitor
-*monitor*alert* @arturodilecce
+*monitor*dashboard* @brokenpip3
+*monitor*alert* @arturodilecce
+

sysdig/internal/client/monitor/model/dashboard.go

@@ -170,13 +170,13 @@ type AdvancedQueries struct {
 	ParentPanel *Panels     `json:"-"`
 }
 
-func NewPromqlQuery(query string, parentPanel *Panels) *AdvancedQueries {
+func NewPromqlQuery(query string, parentPanel *Panels, displayInfo DisplayInfo) *AdvancedQueries {
 	newQuery := &AdvancedQueries{
 		Enabled: true,
 		DisplayInfo: DisplayInfo{
-			DisplayName:                   "",
-			TimeSeriesDisplayNameTemplate: "",
-			Type:                          "lines",
+			DisplayName:                   displayInfo.DisplayName,
+			TimeSeriesDisplayNameTemplate: displayInfo.TimeSeriesDisplayNameTemplate,
+			Type:                          displayInfo.Type,
 		},
 		Format:      newPercentFormat(),
 		Query:       query,

sysdig/resource_sysdig_monitor_dashboard.go

@@ -183,6 +183,28 @@ func resourceSysdigMonitorDashboard() *schema.Resource {
 										Required:         true,
 										ValidateDiagFunc: validateDiagFunc(validation.StringInSlice([]string{"percent", "data", "data rate", "number", "number rate", "time"}, false)),
 									},
+									"display_info": {
+										Type:     schema.TypeSet,
+										Optional: true,
+										MinItems: 1,
+										Elem: &schema.Resource{
+											Schema: map[string]*schema.Schema{
+												"display_name": {
+													Type:     schema.TypeString,
+													Optional: true,
+												},
+												"time_series_display_name_template": {
+													Type:     schema.TypeString,
+													Required: true,
+												},
+												"type": {
+													Type:             schema.TypeString,
+													Required:         true,
+													ValidateDiagFunc: validateDiagFunc(validation.StringInSlice([]string{"lines", "stackedArea", "stackedBar"}, false)),
+												},
+											},
+										},
+									},
 								},
 							},
 						},
@@ -252,7 +274,6 @@ func resourceSysdigDashboardRead(ctx context.Context, data *schema.ResourceData,
 	}
 
 	dashboard, err := client.GetDashboardByID(ctx, id)
-
 	if err != nil {
 		data.SetId("")
 		return nil
@@ -519,10 +540,24 @@ func textPanelFromResourceData(panelInfo map[string]interface{}) (*model.Panels,
 }
 
 func queriesFromResourceData(panelInfo map[string]interface{}, panel *model.Panels) (newQueries []*model.AdvancedQueries, err error) {
+	var display model.DisplayInfo
+
 	for _, queryItr := range panelInfo["query"].(*schema.Set).List() {
 		queryInfo := queryItr.(map[string]interface{})
 
-		promqlQuery := model.NewPromqlQuery(queryInfo["promql"].(string), panel)
+		displayInfo := queryInfo["display_info"].(*schema.Set).List()
+		if len(displayInfo) > 0 {
+			dip := displayInfo[0].(map[string]interface{})
+			display.DisplayName = dip["display_name"].(string)
+			display.TimeSeriesDisplayNameTemplate = dip["time_series_display_name_template"].(string)
+			display.Type = dip["type"].(string)
+		} else {
+			display.DisplayName = ""
+			display.TimeSeriesDisplayNameTemplate = ""
+			display.Type = "lines"
+		}
+
+		promqlQuery := model.NewPromqlQuery(queryInfo["promql"].(string), panel, display)
 
 		switch queryInfo["unit"].(string) {
 		case "percent":
@@ -746,10 +781,22 @@ func queriesToResourceData(advancedQueries []*model.AdvancedQueries) ([]map[stri
 			return nil, fmt.Errorf("unsupported query format unit: %s", query.Format.Unit)
 		}
 
-		queries = append(queries, map[string]interface{}{
-			"unit":   unit,
-			"promql": query.Query,
-		})
+		if query.DisplayInfo.DisplayName == "" && query.DisplayInfo.TimeSeriesDisplayNameTemplate == "" {
+			queries = append(queries, map[string]interface{}{
+				"unit":   unit,
+				"promql": query.Query,
+			})
+		} else {
+			queries = append(queries, map[string]interface{}{
+				"unit":   unit,
+				"promql": query.Query,
+				"display_info": []map[string]interface{}{{
+					"display_name":                      query.DisplayInfo.DisplayName,
+					"time_series_display_name_template": query.DisplayInfo.TimeSeriesDisplayNameTemplate,
+					"type":                              query.DisplayInfo.Type,
+				}},
+			})
+		}
 	}
 	return queries, nil
 }

sysdig/resource_sysdig_monitor_dashboard_test.go

@@ -55,6 +55,9 @@ func TestAccDashboard(t *testing.T) {
 					}),
 				),
 			},
+			{
+				Config: multiplePanelsDashboardWithDisplayInfo(rText()),
+			},
 		},
 	})
 }
@@ -275,3 +278,86 @@ resource "sysdig_monitor_dashboard" "dashboard" {
 }
 `, name, name, name)
 }
+
+func multiplePanelsDashboardWithDisplayInfo(name string) string {
+	return fmt.Sprintf(`
+resource "sysdig_monitor_dashboard" "dashboard" {
+	name = "TERRAFORM TEST - METRIC %s"
+	description = "TERRAFORM TEST - METRIC %s"
+
+	scope {
+		metric = "agent.id"
+		comparator = "in"
+		value = ["foo", "bar"]
+		variable = "agent_id"
+	}
+
+	scope {
+		metric = "agent.name"
+		comparator = "equals"
+		value = ["name"]
+	}
+
+	scope {
+		metric = "kubernetes.namespace.name"
+		variable = "k8_ns"
+	}
+
+	panel {
+		pos_x = 0
+		pos_y = 0
+		width = 12 # Maximum size: 24
+		height = 6
+		type = "timechart"
+		name = "example panel"
+		description = "description"
+
+		query {
+			promql = "avg(avg_over_time(sysdig_host_cpu_used_percent[$__interval]))"
+			unit = "percent"
+			display_info {
+				display_name                      = "hostname"
+				time_series_display_name_template = "{{host_hostname}}"
+				type                              = "lines"
+			}
+		}
+		query {
+			promql = "avg(avg_over_time(sysdig_host_cpu_used_percent{ns_name=$k8s_ns}[$__interval]))"
+			unit = "number"
+			display_info {
+				time_series_display_name_template = "{{host_hostname}}"
+				type                              = "stackedArea"
+			}
+		}
+	}
+
+	panel {
+		pos_x = 12
+		pos_y = 0
+		width = 12
+		height = 6
+		type = "number"
+		name = "example panel - 2"
+		description = "description of panel 2"
+
+		query {
+			promql = "avg(avg_over_time(sysdig_host_cpu_used_percent[$__interval]))"
+			unit = "time"
+		}
+	}
+
+	panel {
+		pos_x = 12
+		pos_y = 12
+		width = 12
+		height = 6
+		type = "text"
+		name = "example panel - 2"
+		content = "description of panel 2"
+		visible_title = true
+		autosize_text = true
+		transparent_background = true
+	}
+}
+`, name, name)
+}

website/docs/r/monitor_dashboard.md

@@ -47,6 +47,11 @@ resource "sysdig_monitor_dashboard" "dashboard" {
     query {
       promql = "avg(avg_over_time(sysdig_host_cpu_used_percent[$__interval]))"
       unit   = "number"
+      display_info {
+        display_name                      = "ct_name"
+        time_series_display_name_template = "{{container_name}}"
+        type                              = "lines"
+      }
     }
   }
 
@@ -166,10 +171,20 @@ The following arguments are supported:
 
 * `promql` - (Required) The PromQL query. Must be a valid PromQL query with existing
              metrics in Sysdig Monitor.
-             
+
 * `unit` - (Required) The type of metric for this query. Can be one of: `percent`, `data`, `data rate`, 
             `number`, `number rate`, `time`.
 
+* `display_info` - (Optional) Configure the time series display visualization for the selected query.
+
+  Nested scheme for `display_info`:
+
+  * `display_name` - (Optional) Configure the query display name summary, the text will appears as a title for the legend.
+
+  * `time_series_display_name_template` - (Required) Configure the display name of the time series for the query using text and any label values returned with the metric. For example: `CPU usage % for {{host}}`.
+
+  * `type` - (Required) Configure the visualization type in the timechart, can be `lines`, `stackedArea`, `stackedBar`
+
 
 ### share