feat(observability-lib): add histogram panel wrapper (#1671)

Author: Atrax1

observability-lib/grafana/builder.go

@@ -107,6 +107,9 @@ func (b *Builder) AddPanel(panel ...*Panel) {
 		} else if item.textPanelBuilder != nil {
 			item.textPanelBuilder.Id(panelID)
 			b.dashboardBuilder.WithPanel(item.textPanelBuilder)
+		} else if item.histogramPanelBuilder != nil {
+			item.histogramPanelBuilder.Id(panelID)
+			b.dashboardBuilder.WithPanel(item.histogramPanelBuilder)
 		} else if item.businessVariablePanelBuilder != nil {
 			item.businessVariablePanelBuilder.Id(panelID)
 			b.dashboardBuilder.WithPanel(item.businessVariablePanelBuilder)

observability-lib/grafana/panels.go

@@ -8,6 +8,7 @@ import (
 	"github.com/grafana/grafana-foundation-sdk/go/dashboard"
 	"github.com/grafana/grafana-foundation-sdk/go/gauge"
 	"github.com/grafana/grafana-foundation-sdk/go/heatmap"
+	"github.com/grafana/grafana-foundation-sdk/go/histogram"
 	"github.com/grafana/grafana-foundation-sdk/go/logs"
 	"github.com/grafana/grafana-foundation-sdk/go/prometheus"
 	"github.com/grafana/grafana-foundation-sdk/go/stat"
@@ -177,6 +178,7 @@ type Panel struct {
 	logPanelBuilder              *logs.PanelBuilder
 	heatmapBuilder               *heatmap.PanelBuilder
 	textPanelBuilder             *text.PanelBuilder
+	histogramPanelBuilder        *histogram.PanelBuilder
 	businessVariablePanelBuilder *businessvariable.PanelBuilder
 	alertBuilders                []*alerting.RuleBuilder
 }
@@ -895,6 +897,172 @@ func NewTextPanel(options *TextPanelOptions) *Panel {
 	}
 }
 
+type HistogramPanelOptions struct {
+	*PanelOptions
+	LineWidth         *float64
+	ScaleDistribution common.ScaleDistribution
+	LegendOptions     *LegendOptions
+	ToolTipOptions    *ToolTipOptions
+	ThresholdStyle    common.GraphThresholdsStyleMode
+	DrawStyle         common.GraphDrawStyle
+	StackingMode      common.StackingMode
+	Combine           *bool
+	FillOpacity       *uint32
+	BucketOffset      *float32
+	BucketCount       *int32
+	BucketSize        *int32
+	AxisBorderShow    *bool
+	AxisLabel         string
+	AxisSoftMax       *float64
+	AxisSoftMin       *float64
+	AxisColorMode     common.AxisColorMode
+	AxisCenteredZero  *bool
+	AxisGridShow      *bool
+	AxisPlacement     common.AxisPlacement
+	AxisWidth         *float64
+}
+
+func NewHistogramPanel(options *HistogramPanelOptions) *Panel {
+	setDefaults(options.PanelOptions)
+
+	if options.ScaleDistribution == "" {
+		options.ScaleDistribution = common.ScaleDistributionLinear
+	}
+
+	if options.LineWidth == nil {
+		options.LineWidth = Pointer[float64](1)
+	}
+
+	if options.LegendOptions == nil {
+		options.LegendOptions = &LegendOptions{}
+	}
+
+	if options.ToolTipOptions == nil {
+		options.ToolTipOptions = &ToolTipOptions{}
+	}
+
+	if options.StackingMode == "" {
+		options.StackingMode = common.StackingModeNone
+	}
+
+	newPanel := histogram.NewPanelBuilder().
+		Datasource(datasourceRef(options.Datasource)).
+		Title(*options.Title).
+		Description(options.Description).
+		Transparent(options.Transparent).
+		Span(options.Span).
+		Height(options.Height).
+		Unit(options.Unit).
+		NoValue(options.NoValue).
+		ScaleDistribution(common.NewScaleDistributionConfigBuilder().
+			Type(options.ScaleDistribution),
+		).
+		Tooltip(newToolTip(options.ToolTipOptions)).
+		Stacking(common.NewStackingConfigBuilder().
+			Mode(options.StackingMode),
+		)
+
+	if options.Interval != "" {
+		newPanel.Interval(options.Interval)
+	}
+
+	if options.Decimals != nil {
+		newPanel.Decimals(*options.Decimals)
+	}
+
+	if options.Min != nil {
+		newPanel.Min(*options.Min)
+	}
+
+	if options.Max != nil {
+		newPanel.Max(*options.Max)
+	}
+
+	for _, q := range options.Query {
+		newPanel.WithTarget(newQuery(q))
+	}
+
+	if options.Threshold != nil {
+		newPanel.Thresholds(newThresholds(options.Threshold))
+	}
+
+	if options.Transforms != nil {
+		for _, transform := range options.Transforms {
+			newPanel.WithTransformation(newTransform(transform))
+		}
+	}
+
+	if options.Overrides != nil {
+		for _, override := range options.Overrides {
+			newPanel.WithOverride(newOverride(override))
+		}
+	}
+
+	if options.Combine != nil {
+		newPanel.Combine(*options.Combine)
+	}
+
+	if options.ColorScheme != "" {
+		newPanel.ColorScheme(dashboard.NewFieldColorBuilder().Mode(options.ColorScheme))
+	}
+
+	if options.FillOpacity != nil {
+		newPanel.FillOpacity(*options.FillOpacity)
+	}
+
+	if options.BucketOffset != nil {
+		newPanel.BucketOffset(*options.BucketOffset)
+	}
+
+	if options.BucketCount != nil {
+		newPanel.BucketCount(*options.BucketCount)
+	}
+
+	if options.BucketSize != nil {
+		newPanel.BucketSize(*options.BucketSize)
+	}
+
+	if options.AxisBorderShow != nil {
+		newPanel.AxisBorderShow(*options.AxisBorderShow)
+	}
+
+	if options.AxisLabel != "" {
+		newPanel.AxisLabel(options.AxisLabel)
+	}
+
+	if options.AxisSoftMax != nil {
+		newPanel.AxisSoftMax(*options.AxisSoftMax)
+	}
+
+	if options.AxisSoftMin != nil {
+		newPanel.AxisSoftMin(*options.AxisSoftMin)
+	}
+
+	if options.AxisColorMode != "" {
+		newPanel.AxisColorMode(options.AxisColorMode)
+	}
+
+	if options.AxisCenteredZero != nil {
+		newPanel.AxisCenteredZero(*options.AxisCenteredZero)
+	}
+
+	if options.AxisGridShow != nil {
+		newPanel.AxisGridShow(*options.AxisGridShow)
+	}
+
+	if options.AxisPlacement != "" {
+		newPanel.AxisPlacement(options.AxisPlacement)
+	}
+
+	if options.AxisWidth != nil {
+		newPanel.AxisWidth(*options.AxisWidth)
+	}
+
+	return &Panel{
+		histogramPanelBuilder: newPanel,
+	}
+}
+
 type BusinessVariablePanelOptions struct {
 	*PanelOptions
 	DisplayMode businessvariable.DisplayMode