mirror of https://github.com/grafana/grafana
Expressions: Add model struct for the query types (not map[string]any) (#82745)
Ryan McKinley
1 year ago
committed by
GitHub
parent
46a77c0074
commit
f23f50f58d
@ -0,0 +1,94 @@ |
||||
package expr |
||||
|
||||
import ( |
||||
"github.com/grafana/grafana/pkg/expr/classic" |
||||
"github.com/grafana/grafana/pkg/expr/mathexp" |
||||
) |
||||
|
||||
// Supported expression types
|
||||
// +enum
|
||||
type QueryType string |
||||
|
||||
const ( |
||||
// Apply a mathematical expression to results
|
||||
QueryTypeMath QueryType = "math" |
||||
|
||||
// Reduce query results
|
||||
QueryTypeReduce QueryType = "reduce" |
||||
|
||||
// Resample query results
|
||||
QueryTypeResample QueryType = "resample" |
||||
|
||||
// Classic query
|
||||
QueryTypeClassic QueryType = "classic_conditions" |
||||
|
||||
// Threshold
|
||||
QueryTypeThreshold QueryType = "threshold" |
||||
) |
||||
|
||||
type MathQuery struct { |
||||
// General math expression
|
||||
Expression string `json:"expression" jsonschema:"minLength=1,example=$A + 1,example=$A/$B"` |
||||
} |
||||
|
||||
type ReduceQuery struct { |
||||
// Reference to single query result
|
||||
Expression string `json:"expression" jsonschema:"minLength=1,example=$A"` |
||||
|
||||
// The reducer
|
||||
Reducer mathexp.ReducerID `json:"reducer"` |
||||
|
||||
// Reducer Options
|
||||
Settings *ReduceSettings `json:"settings,omitempty"` |
||||
} |
||||
|
||||
// QueryType = resample
|
||||
type ResampleQuery struct { |
||||
// The math expression
|
||||
Expression string `json:"expression" jsonschema:"minLength=1,example=$A + 1,example=$A"` |
||||
|
||||
// The time durration
|
||||
Window string `json:"window" jsonschema:"minLength=1,example=1w,example=10m"` |
||||
|
||||
// The downsample function
|
||||
Downsampler string `json:"downsampler"` |
||||
|
||||
// The upsample function
|
||||
Upsampler string `json:"upsampler"` |
||||
} |
||||
|
||||
type ThresholdQuery struct { |
||||
// Reference to single query result
|
||||
Expression string `json:"expression" jsonschema:"minLength=1,example=$A"` |
||||
|
||||
// Threshold Conditions
|
||||
Conditions []ThresholdConditionJSON `json:"conditions"` |
||||
} |
||||
|
||||
type ClassicQuery struct { |
||||
Conditions []classic.ConditionJSON `json:"conditions"` |
||||
} |
||||
|
||||
//-------------------------------
|
||||
// Non-query commands
|
||||
//-------------------------------
|
||||
|
||||
type ReduceSettings struct { |
||||
// Non-number reduce behavior
|
||||
Mode ReduceMode `json:"mode"` |
||||
|
||||
// Only valid when mode is replace
|
||||
ReplaceWithValue *float64 `json:"replaceWithValue,omitempty"` |
||||
} |
||||
|
||||
// Non-Number behavior mode
|
||||
// +enum
|
||||
type ReduceMode string |
||||
|
||||
const ( |
||||
// Drop non-numbers
|
||||
ReduceModeDrop ReduceMode = "dropNN" |
||||
|
||||
// Replace non-numbers
|
||||
ReduceModeReplace ReduceMode = "replaceNN" |
||||
) |
||||
@ -0,0 +1,156 @@ |
||||
package expr |
||||
|
||||
import ( |
||||
"fmt" |
||||
"strings" |
||||
|
||||
"github.com/grafana/grafana-plugin-sdk-go/data/utils/jsoniter" |
||||
|
||||
"github.com/grafana/grafana/pkg/expr/classic" |
||||
"github.com/grafana/grafana/pkg/expr/mathexp" |
||||
"github.com/grafana/grafana/pkg/services/featuremgmt" |
||||
) |
||||
|
||||
// Once we are comfortable with the parsing logic, this struct will
|
||||
// be merged/replace the existing Query struct in grafana/pkg/expr/transform.go
|
||||
type ExpressionQuery struct { |
||||
RefID string |
||||
Command Command |
||||
} |
||||
|
||||
type ExpressionQueryReader struct { |
||||
features featuremgmt.FeatureToggles |
||||
} |
||||
|
||||
func NewExpressionQueryReader(features featuremgmt.FeatureToggles) (*ExpressionQueryReader, error) { |
||||
h := &ExpressionQueryReader{ |
||||
features: features, |
||||
} |
||||
return h, nil |
||||
} |
||||
|
||||
// ReadQuery implements query.TypedQueryHandler.
|
||||
func (h *ExpressionQueryReader) ReadQuery( |
||||
// Properties that have been parsed off the same node
|
||||
common *rawNode, // common query.CommonQueryProperties
|
||||
// An iterator with context for the full node (include common values)
|
||||
iter *jsoniter.Iterator, |
||||
) (eq ExpressionQuery, err error) { |
||||
referenceVar := "" |
||||
eq.RefID = common.RefID |
||||
qt := QueryType(common.QueryType) |
||||
switch qt { |
||||
case QueryTypeMath: |
||||
q := &MathQuery{} |
||||
err = iter.ReadVal(q) |
||||
if err == nil { |
||||
eq.Command, err = NewMathCommand(common.RefID, q.Expression) |
||||
} |
||||
|
||||
case QueryTypeReduce: |
||||
var mapper mathexp.ReduceMapper = nil |
||||
q := &ReduceQuery{} |
||||
err = iter.ReadVal(q) |
||||
if err == nil { |
||||
referenceVar, err = getReferenceVar(q.Expression, common.RefID) |
||||
} |
||||
if err == nil && q.Settings != nil { |
||||
switch q.Settings.Mode { |
||||
case ReduceModeDrop: |
||||
mapper = mathexp.DropNonNumber{} |
||||
case ReduceModeReplace: |
||||
if q.Settings.ReplaceWithValue == nil { |
||||
err = fmt.Errorf("setting replaceWithValue must be specified when mode is '%s'", q.Settings.Mode) |
||||
} |
||||
mapper = mathexp.ReplaceNonNumberWithValue{Value: *q.Settings.ReplaceWithValue} |
||||
default: |
||||
err = fmt.Errorf("unsupported reduce mode") |
||||
} |
||||
} |
||||
if err == nil { |
||||
eq.Command, err = NewReduceCommand(common.RefID, |
||||
q.Reducer, referenceVar, mapper) |
||||
} |
||||
|
||||
case QueryTypeResample: |
||||
q := &ResampleQuery{} |
||||
err = iter.ReadVal(q) |
||||
if err == nil && common.TimeRange == nil { |
||||
err = fmt.Errorf("missing time range in query") |
||||
} |
||||
if err == nil { |
||||
referenceVar, err = getReferenceVar(q.Expression, common.RefID) |
||||
} |
||||
if err == nil { |
||||
// tr := legacydata.NewDataTimeRange(common.TimeRange.From, common.TimeRange.To)
|
||||
// AbsoluteTimeRange{
|
||||
// From: tr.GetFromAsTimeUTC(),
|
||||
// To: tr.GetToAsTimeUTC(),
|
||||
// })
|
||||
eq.Command, err = NewResampleCommand(common.RefID, |
||||
q.Window, |
||||
referenceVar, |
||||
q.Downsampler, |
||||
q.Upsampler, |
||||
common.TimeRange) |
||||
} |
||||
|
||||
case QueryTypeClassic: |
||||
q := &ClassicQuery{} |
||||
err = iter.ReadVal(q) |
||||
if err == nil { |
||||
eq.Command, err = classic.NewConditionCmd(common.RefID, q.Conditions) |
||||
} |
||||
|
||||
case QueryTypeThreshold: |
||||
q := &ThresholdQuery{} |
||||
err = iter.ReadVal(q) |
||||
if err == nil { |
||||
referenceVar, err = getReferenceVar(q.Expression, common.RefID) |
||||
} |
||||
if err == nil { |
||||
// we only support one condition for now, we might want to turn this in to "OR" expressions later
|
||||
if len(q.Conditions) != 1 { |
||||
return eq, fmt.Errorf("threshold expression requires exactly one condition") |
||||
} |
||||
firstCondition := q.Conditions[0] |
||||
|
||||
threshold, err := NewThresholdCommand(common.RefID, referenceVar, firstCondition.Evaluator.Type, firstCondition.Evaluator.Params) |
||||
if err != nil { |
||||
return eq, fmt.Errorf("invalid condition: %w", err) |
||||
} |
||||
eq.Command = threshold |
||||
|
||||
if firstCondition.UnloadEvaluator != nil && h.features.IsEnabledGlobally(featuremgmt.FlagRecoveryThreshold) { |
||||
unloading, err := NewThresholdCommand(common.RefID, referenceVar, firstCondition.UnloadEvaluator.Type, firstCondition.UnloadEvaluator.Params) |
||||
unloading.Invert = true |
||||
if err != nil { |
||||
return eq, fmt.Errorf("invalid unloadCondition: %w", err) |
||||
} |
||||
var d Fingerprints |
||||
if firstCondition.LoadedDimensions != nil { |
||||
d, err = FingerprintsFromFrame(firstCondition.LoadedDimensions) |
||||
if err != nil { |
||||
return eq, fmt.Errorf("failed to parse loaded dimensions: %w", err) |
||||
} |
||||
} |
||||
eq.Command, err = NewHysteresisCommand(common.RefID, referenceVar, *threshold, *unloading, d) |
||||
if err != nil { |
||||
return eq, err |
||||
} |
||||
} |
||||
} |
||||
|
||||
default: |
||||
err = fmt.Errorf("unknown query type (%s)", common.QueryType) |
||||
} |
||||
return eq, err |
||||
} |
||||
|
||||
func getReferenceVar(exp string, refId string) (string, error) { |
||||
exp = strings.TrimPrefix(exp, "%") |
||||
if exp == "" { |
||||
return "", fmt.Errorf("no variable specified to reference for refId %v", refId) |
||||
} |
||||
return exp, nil |
||||
} |
||||
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in new issue