feat: support grafana-polystat-plugin

Author: agparadiso

observability-lib/grafana/builder.go

@@ -8,7 +8,9 @@ import (
 	"github.com/grafana/grafana-foundation-sdk/go/cog/plugins"
 	"github.com/grafana/grafana-foundation-sdk/go/common"
 	"github.com/grafana/grafana-foundation-sdk/go/dashboard"
+
 	"github.com/smartcontractkit/chainlink-common/observability-lib/grafana/businessvariable"
+	"github.com/smartcontractkit/chainlink-common/observability-lib/grafana/polystat"
 )
 
 type Builder struct {
@@ -35,6 +37,7 @@ type BuilderOptions struct {
 func NewBuilder(options *BuilderOptions) *Builder {
 	plugins.RegisterDefaultPlugins()
 	cog.NewRuntime().RegisterPanelcfgVariant(businessvariable.VariantConfig())
+	cog.NewRuntime().RegisterPanelcfgVariant(polystat.VariantConfig())
 
 	builder := &Builder{}
 
@@ -113,6 +116,9 @@ func (b *Builder) AddPanel(panel ...*Panel) {
 		} else if item.businessVariablePanelBuilder != nil {
 			item.businessVariablePanelBuilder.Id(panelID)
 			b.dashboardBuilder.WithPanel(item.businessVariablePanelBuilder)
+		} else if item.polystatPanelBuilder != nil {
+			item.polystatPanelBuilder.Id(panelID)
+			b.dashboardBuilder.WithPanel(item.polystatPanelBuilder)
 		}
 		if item.alertBuilders != nil && len(item.alertBuilders) > 0 {
 			b.AddAlert(item.alertBuilders...)

observability-lib/grafana/panels.go

@@ -15,7 +15,9 @@ import (
 	"github.com/grafana/grafana-foundation-sdk/go/table"
 	"github.com/grafana/grafana-foundation-sdk/go/text"
 	"github.com/grafana/grafana-foundation-sdk/go/timeseries"
+
 	"github.com/smartcontractkit/chainlink-common/observability-lib/grafana/businessvariable"
+	"github.com/smartcontractkit/chainlink-common/observability-lib/grafana/polystat"
 )
 
 type QueryType string
@@ -180,6 +182,7 @@ type Panel struct {
 	textPanelBuilder             *text.PanelBuilder
 	histogramPanelBuilder        *histogram.PanelBuilder
 	businessVariablePanelBuilder *businessvariable.PanelBuilder
+	polystatPanelBuilder         *polystat.PanelBuilder
 	alertBuilders                []*alerting.RuleBuilder
 }
 
@@ -1092,3 +1095,130 @@ func NewBusinessVariablePanel(options *BusinessVariablePanelOptions) *Panel {
 		businessVariablePanelBuilder: newPanel,
 	}
 }
+
+type PolystatPanelOptions struct {
+	*PanelOptions
+	Queries                         []Query
+	OperatorName                    polystat.OperatorName
+	PolygonGlobalFillColor          string
+	PolygonSize                     polystat.PolygonSize
+	Columns                         *int
+	Rows                            *int
+	DisplayLimit                    *int
+	DefaultClickThrough             string
+	DefaultClickThroughNewTab       bool
+	DefaultClickThroughSanitize     bool
+	AnimationSpeed                  *int
+	Radius                          string
+	TooltipDisplayMode              string
+	TooltipPrimarySortBy            polystat.SortByField
+	TooltipPrimarySortDirection     polystat.SortByDirection
+	TooltipSecondarySortBy          polystat.SortByField
+	TooltipSecondarySortDirection   polystat.SortByDirection
+	GlobalUnitFormat                string
+	GlobalDecimals                  *int
+	GlobalDisplayMode               string
+	GlobalDisplayTextTriggeredEmpty string
+	GlobalThresholds                []polystat.Threshold
+}
+
+func NewPolystatPanel(options *PolystatPanelOptions) *Panel {
+	setDefaults(options.PanelOptions)
+
+	newPanel := polystat.NewPanelBuilder().
+		Datasource(datasourceRef(options.Datasource)).
+		Title(*options.Title).
+		Description(options.Description).
+		Transparent(options.Transparent).
+		Span(options.Span).
+		Height(options.Height).
+		OperatorName(options.OperatorName)
+
+	if options.PolygonGlobalFillColor != "" {
+		newPanel.PolygonGlobalFillColor(options.PolygonGlobalFillColor)
+	}
+
+	if options.PolygonSize != 0 {
+		newPanel.PolygonSize(options.PolygonSize)
+	}
+
+	if options.Columns != nil {
+		newPanel.Columns(*options.Columns)
+	}
+
+	if options.Rows != nil {
+		newPanel.Rows(*options.Rows)
+	}
+
+	if options.DisplayLimit != nil {
+		newPanel.DisplayLimit(*options.DisplayLimit)
+	}
+
+	if options.DefaultClickThrough != "" {
+		newPanel.DefaultClickThrough(options.DefaultClickThrough)
+	}
+
+	if options.DefaultClickThroughNewTab {
+		newPanel.DefaultClickThroughNewTab(options.DefaultClickThroughNewTab)
+	}
+
+	if options.DefaultClickThroughSanitize {
+		newPanel.DefaultClickThroughSanitize(options.DefaultClickThroughSanitize)
+	}
+
+	if options.AnimationSpeed != nil {
+		newPanel.AnimationSpeed(*options.AnimationSpeed)
+	}
+
+	if options.Radius != "" {
+		newPanel.Radius(options.Radius)
+	}
+
+	if options.TooltipDisplayMode != "" {
+		newPanel.TooltipDisplayMode(options.TooltipDisplayMode)
+	}
+
+	if options.TooltipPrimarySortBy != "" {
+		newPanel.TooltipPrimarySortBy(options.TooltipPrimarySortBy)
+	}
+
+	if options.TooltipPrimarySortDirection != "" {
+		newPanel.TooltipPrimarySortDirection(options.TooltipPrimarySortDirection)
+	}
+
+	if options.TooltipSecondarySortBy != "" {
+		newPanel.TooltipSecondarySortBy(options.TooltipSecondarySortBy)
+	}
+
+	if options.TooltipSecondarySortDirection != "" {
+		newPanel.TooltipSecondarySortDirection(options.TooltipSecondarySortDirection)
+	}
+
+	if options.GlobalUnitFormat != "" {
+		newPanel.GlobalUnitFormat(options.GlobalUnitFormat)
+	}
+
+	if options.GlobalDecimals != nil {
+		newPanel.GlobalDecimals(*options.GlobalDecimals)
+	}
+
+	if options.GlobalDisplayMode != "" {
+		newPanel.GlobalDisplayMode(options.GlobalDisplayMode)
+	}
+
+	if options.GlobalDisplayTextTriggeredEmpty != "" {
+		newPanel.GlobalDisplayTextTriggeredEmpty(options.GlobalDisplayTextTriggeredEmpty)
+	}
+
+	if len(options.GlobalThresholds) > 0 {
+		newPanel.GlobalThresholds(options.GlobalThresholds)
+	}
+
+	for _, query := range options.Queries {
+		newPanel.WithTarget(newQuery(query))
+	}
+
+	return &Panel{
+		polystatPanelBuilder: newPanel,
+	}
+}