Various updates to Observability Library (#1022)

- Fix alert query type not instant when the query is instant
- Add disable resolve message and uid to contact point
- Add stacking mode to time series panel
- Add multi and include all to custom variable
- Use csv when the variable key and value is the same
- Fix delete notification template status code should be 204
- Add annotations to alerts
- Derive notification templates name from file name

observability-lib/api/notification-template.go

@@ -45,7 +45,7 @@ func (c *Client) DeleteNotificationTemplate(name string) (DeleteNotificationTemp
 	}
 
 	statusCode := resp.StatusCode()
-	if statusCode != 200 {
+	if statusCode != 204 {
 		return DeleteNotificationTemplateResponse{}, resp, fmt.Errorf("error deleting notification template, received unexpected status code %d: %s", statusCode, resp.String())
 	}
 

observability-lib/grafana/alerts.go

@@ -1,6 +1,8 @@
 package grafana
 
 import (
+	"maps"
+
 	"github.com/grafana/grafana-foundation-sdk/go/alerting"
 	"github.com/grafana/grafana-foundation-sdk/go/cog"
 	"github.com/grafana/grafana-foundation-sdk/go/expr"
@@ -35,6 +37,7 @@ func newRuleQuery(query RuleQuery) *alerting.QueryBuilder {
 		RefId(query.RefID)
 
 	if query.Instant {
+		model.QueryType("instant")
 		model.Instant()
 	}
 
@@ -170,6 +173,7 @@ type AlertOptions struct {
 	For               string
 	NoDataState       alerting.RuleNoDataState
 	RuleExecErrState  alerting.RuleExecErrState
+	Annotations       map[string]string
 	Tags              map[string]string
 	Query             []RuleQuery
 	QueryRefCondition string
@@ -200,6 +204,7 @@ func NewAlertRule(options *AlertOptions) *alerting.RuleBuilder {
 		"description": options.Description,
 		"runbook_url": options.RunbookURL,
 	}
+	maps.Copy(annotations, options.Annotations)
 
 	if options.PanelTitle != "" {
 		annotations["panel_title"] = options.PanelTitle

observability-lib/grafana/contact-point.go

@@ -3,14 +3,23 @@ package grafana
 import "github.com/grafana/grafana-foundation-sdk/go/alerting"
 
 type ContactPointOptions struct {
-	Name     string
-	Type     alerting.ContactPointType
-	Settings map[string]interface{}
+	Name                  string
+	Type                  alerting.ContactPointType
+	Settings              map[string]interface{}
+	DisableResolveMessage bool
+	Uid                   string
 }
 
 func NewContactPoint(options *ContactPointOptions) *alerting.ContactPointBuilder {
-	return alerting.NewContactPointBuilder().
+	builder := alerting.NewContactPointBuilder().
 		Name(options.Name).
 		Type(options.Type).
-		Settings(options.Settings)
+		Settings(options.Settings).
+		DisableResolveMessage(options.DisableResolveMessage)
+
+	if options.Uid != "" {
+		builder.Uid(options.Uid)
+	}
+
+	return builder
 }

observability-lib/grafana/notification-template.go

@@ -3,21 +3,25 @@ package grafana
 import (
 	"fmt"
 	"os"
+	"path/filepath"
+	"strings"
 
 	"github.com/grafana/grafana-foundation-sdk/go/alerting"
 	"gopkg.in/yaml.v3"
 )
 
-func NewNotificationTemplatesFromFile(filepath string) (map[string]alerting.NotificationTemplate, error) {
+func NewNotificationTemplatesFromFile(filePath string) (map[string]alerting.NotificationTemplate, error) {
+	fileName := strings.TrimSuffix(filepath.Base(filePath), filepath.Ext(filePath))
+
 	notificationTemplates := make(map[string]alerting.NotificationTemplate)
-	yamlFileToMapRes, errFileToMap := yamlFileToMap(filepath)
+	yamlFileToMapRes, errFileToMap := yamlFileToMap(filePath)
 	if errFileToMap != nil {
 		return nil, errFileToMap
 	}
 
 	for typeTemplate, template := range yamlFileToMapRes {
 		newTemplate, err := alerting.NewNotificationTemplateBuilder().
-			Name(fmt.Sprintf("chainlink-%s-notification-template", typeTemplate)).
+			Name(fmt.Sprintf("%s-%s-notification-template", fileName, typeTemplate)).
 			Template(template).Build()
 		if err != nil {
 			return nil, err

observability-lib/grafana/panels.go

@@ -279,6 +279,7 @@ type TimeSeriesPanelOptions struct {
 	ToolTipOptions    *ToolTipOptions
 	ThresholdStyle    common.GraphThresholdsStyleMode
 	DrawStyle         common.GraphDrawStyle
+	StackingMode      common.StackingMode
 }
 
 func NewTimeSeriesPanel(options *TimeSeriesPanelOptions) *Panel {
@@ -300,6 +301,10 @@ func NewTimeSeriesPanel(options *TimeSeriesPanelOptions) *Panel {
 		options.ToolTipOptions = &ToolTipOptions{}
 	}
 
+	if options.StackingMode == "" {
+		options.StackingMode = common.StackingModeNone
+	}
+
 	newPanel := timeseries.NewPanelBuilder().
 		Datasource(datasourceRef(options.Datasource)).
 		Title(*options.Title).
@@ -315,7 +320,11 @@ func NewTimeSeriesPanel(options *TimeSeriesPanelOptions) *Panel {
 		ScaleDistribution(common.NewScaleDistributionConfigBuilder().
 			Type(options.ScaleDistribution),
 		).
-		Tooltip(newToolTip(options.ToolTipOptions))
+		Tooltip(newToolTip(options.ToolTipOptions)).
+		// Time Series Panel Options
+		Stacking(common.NewStackingConfigBuilder().
+			Mode(options.StackingMode),
+		)
 
 	if options.Decimals != nil {
 		newPanel.Decimals(*options.Decimals)

observability-lib/grafana/variables.go

@@ -21,7 +21,9 @@ type VariableOption struct {
 
 type CustomVariableOptions struct {
 	*VariableOption
-	Values map[string]any
+	Values     map[string]any
+	Multi      bool
+	IncludeAll bool
 }
 
 func NewCustomVariable(options *CustomVariableOptions) *dashboard.CustomVariableBuilder {
@@ -38,7 +40,9 @@ func NewCustomVariable(options *CustomVariableOptions) *dashboard.CustomVariable
 			Selected: cog.ToPtr[bool](true),
 			Text:     dashboard.StringOrArrayOfString{String: cog.ToPtr(options.CurrentText)},
 			Value:    dashboard.StringOrArrayOfString{String: cog.ToPtr(options.CurrentValue)},
-		})
+		}).
+		Multi(options.Multi).
+		IncludeAll(options.IncludeAll)
 
 	optionsList := []dashboard.VariableOption{
 		{
@@ -63,7 +67,11 @@ func NewCustomVariable(options *CustomVariableOptions) *dashboard.CustomVariable
 		// Escape commas and colons in the value which are reserved characters for values string
 		cleanValue := strings.ReplaceAll(value.(string), ",", "\\,")
 		cleanValue = strings.ReplaceAll(cleanValue, ":", "\\:")
-		valuesString += key + " : " + cleanValue + " , "
+		valuesString += key
+		if key != cleanValue {
+			valuesString += " : " + cleanValue
+		}
+		valuesString += ", "
 	}
 	variable.Values(dashboard.StringOrMap{String: cog.ToPtr(strings.TrimSuffix(valuesString, ", "))})