Skip to content

Commit

Permalink
feat(grafana): add transforms (#1036)
Browse files Browse the repository at this point in the history
Co-authored-by: Clement <[email protected]>
  • Loading branch information
leeyikjiun and Atrax1 authored Feb 19, 2025
1 parent 9cc20a9 commit 5005fc9
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 23 deletions.
55 changes: 32 additions & 23 deletions observability-lib/grafana/panels.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,10 @@ func newThresholds(options *ThresholdOptions) *dashboard.ThresholdsConfigBuilder
return builder
}

type TransformOptions struct {
ID string
Options map[string]any
}

func newTransform(options *TransformOptions) dashboard.DataTransformerConfig {
func newTransform(transform *Transform) dashboard.DataTransformerConfig {
return dashboard.DataTransformerConfig{
Id: options.ID,
Options: options.Options,
Id: transform.ID,
Options: transform.Options,
}
}

Expand Down Expand Up @@ -156,7 +151,7 @@ type PanelOptions struct {
MaxDataPoints *float64
Query []Query
Threshold *ThresholdOptions
Transform *TransformOptions
Transforms []*Transform
Overrides []*Override
ColorScheme dashboard.FieldColorModeId
Interval string
Expand Down Expand Up @@ -283,8 +278,10 @@ func NewStatPanel(options *StatPanelOptions) *Panel {
newPanel.Thresholds(newThresholds(options.Threshold))
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down Expand Up @@ -395,8 +392,10 @@ func NewTimeSeriesPanel(options *TimeSeriesPanelOptions) *Panel {
newPanel.DrawStyle(options.DrawStyle)
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down Expand Up @@ -482,8 +481,10 @@ func NewBarGaugePanel(options *BarGaugePanelOptions) *Panel {
newPanel.Thresholds(newThresholds(options.Threshold))
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down Expand Up @@ -549,8 +550,10 @@ func NewGaugePanel(options *GaugePanelOptions) *Panel {
newPanel.Thresholds(newThresholds(options.Threshold))
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down Expand Up @@ -609,8 +612,10 @@ func NewTablePanel(options *TablePanelOptions) *Panel {
newPanel.Thresholds(newThresholds(options.Threshold))
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down Expand Up @@ -694,8 +699,10 @@ func NewLogPanel(options *LogPanelOptions) *Panel {
newPanel.Thresholds(newThresholds(options.Threshold))
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down Expand Up @@ -755,8 +762,10 @@ func NewHeatmapPanel(options *HeatmapPanelOptions) *Panel {
newPanel.Thresholds(newThresholds(options.Threshold))
}

if options.Transform != nil {
newPanel.WithTransformation(newTransform(options.Transform))
if options.Transforms != nil {
for _, transform := range options.Transforms {
newPanel.WithTransformation(newTransform(transform))
}
}

if options.Overrides != nil {
Expand Down
93 changes: 93 additions & 0 deletions observability-lib/grafana/transforms.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
package grafana

type Transform struct {
ID string
Options map[string]any
}

type JoinByFieldMode string

const (
JoinByFieldModeOuter JoinByFieldMode = "outer"
JoinByFieldModeOuterTabular JoinByFieldMode = "outerTabular"
JoinByFieldModeOuterInner JoinByFieldMode = "inner"
)

type JoinByFieldTransformOptions struct {
ByField string
Mode JoinByFieldMode
}

func NewJoinByFieldTransform(options *JoinByFieldTransformOptions) *Transform {
return &Transform{
ID: "joinByField",
Options: map[string]any{
"byField": options.ByField,
"mode": options.Mode,
},
}
}

type OrganizeTransformOptions struct {
ExcludeByName map[string]bool
IndexByName map[string]int
RenameByName map[string]string
IncludeByName map[string]bool
}

func NewOrganizeTransform(options *OrganizeTransformOptions) *Transform {
return &Transform{
ID: "organize",
Options: map[string]any{
"excludeByName": options.ExcludeByName,
"indexByName": options.IndexByName,
"renameByName": options.RenameByName,
"includeByName": options.IncludeByName,
},
}
}

type ConversionOptions struct {
TargetField string
}

type Conversion map[string]any

type TimeConversionOptions struct {
*ConversionOptions
}

func NewTimeConversion(options *TimeConversionOptions) *Conversion {
return &Conversion{
"targetField": options.TargetField,
"destinationType": "time",
}
}

type ConvertFieldTypeTransformOptions struct {
Conversions []*Conversion
}

func NewConvertFieldTypeTransform(options *ConvertFieldTypeTransformOptions) *Transform {
return &Transform{
ID: "convertFieldType",
Options: map[string]any{
"conversions": options.Conversions,
},
}
}

type RenameByRegexTransformOptions struct {
Regex string
RenamePattern string
}

func NewRenameByRegexTransform(options *RenameByRegexTransformOptions) *Transform {
return &Transform{
ID: "renameByRegex",
Options: map[string]any{
"regex": options.Regex,
"renamePattern": options.RenamePattern,
},
}
}

0 comments on commit 5005fc9

Please sign in to comment.