mirror of
https://github.com/SigNoz/signoz.git
synced 2026-07-14 18:40:26 +01:00
Compare commits
1 Commits
issue-1000
...
feat/rules
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6218e27ec2 |
@@ -7415,6 +7415,7 @@ components:
|
||||
queries:
|
||||
items:
|
||||
$ref: '#/components/schemas/Querybuildertypesv5QueryEnvelope'
|
||||
minItems: 1
|
||||
nullable: true
|
||||
type: array
|
||||
queryType:
|
||||
@@ -7601,35 +7602,28 @@ components:
|
||||
type: string
|
||||
disabled:
|
||||
type: boolean
|
||||
evalWindow:
|
||||
type: string
|
||||
evaluation:
|
||||
$ref: '#/components/schemas/RuletypesEvaluationEnvelope'
|
||||
frequency:
|
||||
type: string
|
||||
labels:
|
||||
additionalProperties:
|
||||
type: string
|
||||
type: object
|
||||
notificationSettings:
|
||||
$ref: '#/components/schemas/RuletypesNotificationSettings'
|
||||
preferredChannels:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
ruleType:
|
||||
$ref: '#/components/schemas/RuletypesRuleType'
|
||||
schemaVersion:
|
||||
type: string
|
||||
source:
|
||||
type: string
|
||||
version:
|
||||
enum:
|
||||
- v2alpha1
|
||||
type: string
|
||||
required:
|
||||
- alert
|
||||
- alertType
|
||||
- ruleType
|
||||
- condition
|
||||
- schemaVersion
|
||||
- evaluation
|
||||
- notificationSettings
|
||||
type: object
|
||||
RuletypesQueryType:
|
||||
enum:
|
||||
@@ -7679,12 +7673,8 @@ components:
|
||||
type: string
|
||||
disabled:
|
||||
type: boolean
|
||||
evalWindow:
|
||||
type: string
|
||||
evaluation:
|
||||
$ref: '#/components/schemas/RuletypesEvaluationEnvelope'
|
||||
frequency:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
labels:
|
||||
@@ -7693,15 +7683,11 @@ components:
|
||||
type: object
|
||||
notificationSettings:
|
||||
$ref: '#/components/schemas/RuletypesNotificationSettings'
|
||||
preferredChannels:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
ruleType:
|
||||
$ref: '#/components/schemas/RuletypesRuleType'
|
||||
schemaVersion:
|
||||
type: string
|
||||
source:
|
||||
enum:
|
||||
- v2alpha1
|
||||
type: string
|
||||
state:
|
||||
$ref: '#/components/schemas/RuletypesAlertState'
|
||||
@@ -7710,8 +7696,6 @@ components:
|
||||
type: string
|
||||
updatedBy:
|
||||
type: string
|
||||
version:
|
||||
type: string
|
||||
required:
|
||||
- id
|
||||
- state
|
||||
@@ -7719,6 +7703,9 @@ components:
|
||||
- alertType
|
||||
- ruleType
|
||||
- condition
|
||||
- schemaVersion
|
||||
- evaluation
|
||||
- notificationSettings
|
||||
type: object
|
||||
RuletypesRuleCondition:
|
||||
properties:
|
||||
@@ -7731,10 +7718,6 @@ components:
|
||||
type: string
|
||||
compositeQuery:
|
||||
$ref: '#/components/schemas/RuletypesAlertCompositeQuery'
|
||||
matchType:
|
||||
$ref: '#/components/schemas/RuletypesMatchType'
|
||||
op:
|
||||
$ref: '#/components/schemas/RuletypesCompareOperator'
|
||||
requireMinPoints:
|
||||
type: boolean
|
||||
requiredNumPoints:
|
||||
@@ -7743,16 +7726,12 @@ components:
|
||||
$ref: '#/components/schemas/RuletypesSeasonality'
|
||||
selectedQueryName:
|
||||
type: string
|
||||
target:
|
||||
format: double
|
||||
nullable: true
|
||||
type: number
|
||||
targetUnit:
|
||||
type: string
|
||||
thresholds:
|
||||
$ref: '#/components/schemas/RuletypesRuleThresholdData'
|
||||
required:
|
||||
- compositeQuery
|
||||
- thresholds
|
||||
- selectedQueryName
|
||||
type: object
|
||||
RuletypesRuleThresholdData:
|
||||
discriminator:
|
||||
|
||||
@@ -100,7 +100,7 @@ func (QueryType) Enum() []any {
|
||||
}
|
||||
|
||||
type AlertCompositeQuery struct {
|
||||
Queries []qbtypes.QueryEnvelope `json:"queries" required:"true"`
|
||||
Queries []qbtypes.QueryEnvelope `json:"queries" required:"true" minItems:"1"`
|
||||
|
||||
PanelType PanelType `json:"panelType" required:"true"`
|
||||
QueryType QueryType `json:"queryType" required:"true"`
|
||||
|
||||
46
pkg/types/ruletypes/jsonschema.go
Normal file
46
pkg/types/ruletypes/jsonschema.go
Normal file
@@ -0,0 +1,46 @@
|
||||
package ruletypes
|
||||
|
||||
import (
|
||||
"github.com/swaggest/jsonschema-go"
|
||||
)
|
||||
|
||||
var (
|
||||
_ jsonschema.Preparer = (*PostableRule)(nil)
|
||||
_ jsonschema.Preparer = (*RuleCondition)(nil)
|
||||
)
|
||||
|
||||
// PrepareJSONSchema restricts the published rule schema to the v2alpha1
|
||||
// contract: the v1-only fields (evalWindow, frequency, preferredChannels) and
|
||||
// the query version (always "v5", defaulted by the server) are omitted, and
|
||||
// the fields the server requires for schemaVersion v2alpha1 are marked
|
||||
// required. Runtime JSON handling is unchanged and continues to load stored
|
||||
// v1 rules until schemaVersion v1 is removed.
|
||||
//
|
||||
// Rule and GettableRule embed PostableRule, so this also applies to the
|
||||
// published read models through method promotion.
|
||||
func (r *PostableRule) PrepareJSONSchema(schema *jsonschema.Schema) error {
|
||||
for _, name := range []string{"evalWindow", "frequency", "preferredChannels", "version", "source"} {
|
||||
delete(schema.Properties, name)
|
||||
}
|
||||
|
||||
schema.Required = append(schema.Required, "schemaVersion", "evaluation", "notificationSettings")
|
||||
|
||||
if prop, ok := schema.Properties["schemaVersion"]; ok && prop.TypeObject != nil {
|
||||
prop.TypeObject.WithEnum(SchemaVersionV2Alpha1)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// PrepareJSONSchema removes the v1-only condition fields (target, op,
|
||||
// matchType, targetUnit — expressed per threshold entry in v2alpha1) from the
|
||||
// published schema and marks thresholds and selectedQueryName required.
|
||||
func (rc *RuleCondition) PrepareJSONSchema(schema *jsonschema.Schema) error {
|
||||
for _, name := range []string{"target", "op", "matchType", "targetUnit"} {
|
||||
delete(schema.Properties, name)
|
||||
}
|
||||
|
||||
schema.Required = append(schema.Required, "thresholds", "selectedQueryName")
|
||||
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user