IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Alerting: Update GettableRuleGroupConfig and PostableRuleGroupConfig with missing fields supported by Prometheus (#94030)

Browse Source
This commit is contained in:
Yuri Tseretyan
2024-10-01 14:17:57 -04:00
committed by GitHub
parent aa225a4450
commit 78290301f4
6 changed files with 358 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
pkg/services/ngalert/api/tooling/api.json
View File

@@ -163,6 +163,14 @@
],
"type": "object"
},
"AlertRuleEditorSettings": {
"properties": {
"simplified_query_and_expressions_section": {
"type": "boolean"
}
},
"type": "object"
},
"AlertRuleExport": {
"properties": {
"annotations": {
@@ -286,6 +294,14 @@
},
"type": "object"
},
"AlertRuleMetadata": {
"properties": {
"editor_settings": {
"$ref": "#/definitions/AlertRuleEditorSettings"
}
},
"type": "object"
},
"AlertRuleNotificationSettings": {
"properties": {
"group_by": {
@@ -1573,6 +1589,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"namespace_uid": {
"type": "string"
},
@@ -1660,12 +1679,25 @@
},
"GettableRuleGroupConfig": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/definitions/GettableExtendedRuleNode"
@@ -2786,6 +2818,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"no_data_state": {
"enum": [
"Alerting",
@@ -2824,17 +2859,36 @@
},
"PostableRuleGroupConfig": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/definitions/PostableExtendedRuleNode"
},
"type": "array"
},
"source_tenants": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
@@ -3616,12 +3670,25 @@
},
"RuleGroupConfigResponse": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/definitions/GettableExtendedRuleNode"

21
pkg/services/ngalert/api/tooling/definitions/cortex-ruler.go
View File

@@ -237,6 +237,14 @@ type PostableRuleGroupConfig struct {
Name string `yaml:"name" json:"name"`
Interval model.Duration `yaml:"interval,omitempty" json:"interval,omitempty"`
Rules []PostableExtendedRuleNode `yaml:"rules" json:"rules"`
// fields below are used by Mimir/Loki rulers
SourceTenants []string `yaml:"source_tenants,omitempty" json:"source_tenants,omitempty"`
EvaluationDelay *model.Duration `yaml:"evaluation_delay,omitempty" json:"evaluation_delay,omitempty"`
QueryOffset *model.Duration `yaml:"query_offset,omitempty" json:"query_offset,omitempty"`
AlignEvaluationTimeOnInterval bool `yaml:"align_evaluation_time_on_interval,omitempty" json:"align_evaluation_time_on_interval,omitempty"`
Limit int `yaml:"limit,omitempty" json:"limit,omitempty"`
}
func (c *PostableRuleGroupConfig) UnmarshalJSON(b []byte) error {
@@ -275,6 +283,10 @@ func (c *PostableRuleGroupConfig) validate() error {
if hasGrafRules && hasLotexRules {
return fmt.Errorf("cannot mix Grafana & Prometheus style rules")
}
if hasGrafRules && (len(c.SourceTenants) > 0 || c.EvaluationDelay != nil || c.QueryOffset != nil || c.AlignEvaluationTimeOnInterval || c.Limit > 0) {
return fmt.Errorf("fields source_tenants, evaluation_delay, query_offset, align_evaluation_time_on_interval and limit are not supported for Grafana rules")
}
return nil
}
@@ -282,8 +294,15 @@ func (c *PostableRuleGroupConfig) validate() error {
type GettableRuleGroupConfig struct {
Name string `yaml:"name" json:"name"`
Interval model.Duration `yaml:"interval,omitempty" json:"interval,omitempty"`
SourceTenants []string `yaml:"source_tenants,omitempty" json:"source_tenants,omitempty"`
Rules []GettableExtendedRuleNode `yaml:"rules" json:"rules"`
// fields below are used by Mimir/Loki rulers
SourceTenants []string `yaml:"source_tenants,omitempty" json:"source_tenants,omitempty"`
EvaluationDelay *model.Duration `yaml:"evaluation_delay,omitempty" json:"evaluation_delay,omitempty"`
QueryOffset *model.Duration `yaml:"query_offset,omitempty" json:"query_offset,omitempty"`
AlignEvaluationTimeOnInterval bool `yaml:"align_evaluation_time_on_interval,omitempty" json:"align_evaluation_time_on_interval,omitempty"`
Limit int `yaml:"limit,omitempty" json:"limit,omitempty"`
}
func (c *GettableRuleGroupConfig) UnmarshalJSON(b []byte) error {

67
pkg/services/ngalert/api/tooling/post.json
View File

@@ -163,6 +163,14 @@
],
"type": "object"
},
"AlertRuleEditorSettings": {
"properties": {
"simplified_query_and_expressions_section": {
"type": "boolean"
}
},
"type": "object"
},
"AlertRuleExport": {
"properties": {
"annotations": {
@@ -286,6 +294,14 @@
},
"type": "object"
},
"AlertRuleMetadata": {
"properties": {
"editor_settings": {
"$ref": "#/definitions/AlertRuleEditorSettings"
}
},
"type": "object"
},
"AlertRuleNotificationSettings": {
"properties": {
"group_by": {
@@ -1573,6 +1589,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"namespace_uid": {
"type": "string"
},
@@ -1660,12 +1679,25 @@
},
"GettableRuleGroupConfig": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/definitions/GettableExtendedRuleNode"
@@ -2786,6 +2818,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"no_data_state": {
"enum": [
"Alerting",
@@ -2824,17 +2859,36 @@
},
"PostableRuleGroupConfig": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/definitions/PostableExtendedRuleNode"
},
"type": "array"
},
"source_tenants": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
@@ -3616,12 +3670,25 @@
},
"RuleGroupConfigResponse": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/definitions/GettableExtendedRuleNode"

67
pkg/services/ngalert/api/tooling/spec.json
View File

@@ -3794,6 +3794,14 @@
}
}
},
"AlertRuleEditorSettings": {
"type": "object",
"properties": {
"simplified_query_and_expressions_section": {
"type": "boolean"
}
}
},
"AlertRuleExport": {
"type": "object",
"title": "AlertRuleExport is the provisioned file export of models.AlertRule.",
@@ -3917,6 +3925,14 @@
}
}
},
"AlertRuleMetadata": {
"type": "object",
"properties": {
"editor_settings": {
"$ref": "#/definitions/AlertRuleEditorSettings"
}
}
},
"AlertRuleNotificationSettings": {
"type": "object",
"required": [
@@ -5206,6 +5222,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"namespace_uid": {
"type": "string"
},
@@ -5293,12 +5312,25 @@
"GettableRuleGroupConfig": {
"type": "object",
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
@@ -6420,6 +6452,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"no_data_state": {
"type": "string",
"enum": [
@@ -6458,17 +6493,36 @@
"PostableRuleGroupConfig": {
"type": "object",
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/PostableExtendedRuleNode"
}
},
"source_tenants": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
@@ -7250,12 +7304,25 @@
"RuleGroupConfigResponse": {
"type": "object",
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"type": "array",
"items": {

67
public/api-merged.json
View File

@@ -12394,6 +12394,14 @@
}
}
},
"AlertRuleEditorSettings": {
"type": "object",
"properties": {
"simplified_query_and_expressions_section": {
"type": "boolean"
}
}
},
"AlertRuleExport": {
"type": "object",
"title": "AlertRuleExport is the provisioned file export of models.AlertRule.",
@@ -12517,6 +12525,14 @@
}
}
},
"AlertRuleMetadata": {
"type": "object",
"properties": {
"editor_settings": {
"$ref": "#/definitions/AlertRuleEditorSettings"
}
}
},
"AlertRuleNotificationSettings": {
"type": "object",
"required": [
@@ -15799,6 +15815,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"namespace_uid": {
"type": "string"
},
@@ -15886,12 +15905,25 @@
"GettableRuleGroupConfig": {
"type": "object",
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
@@ -18087,6 +18119,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/definitions/AlertRuleMetadata"
},
"no_data_state": {
"type": "string",
"enum": [
@@ -18125,17 +18160,36 @@
"PostableRuleGroupConfig": {
"type": "object",
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/PostableExtendedRuleNode"
}
},
"source_tenants": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
@@ -19600,12 +19654,25 @@
"RuleGroupConfigResponse": {
"type": "object",
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/definitions/Duration"
},
"limit": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"type": "array",
"items": {

67
public/openapi3.json
View File

@@ -2621,6 +2621,14 @@
],
"type": "object"
},
"AlertRuleEditorSettings": {
"properties": {
"simplified_query_and_expressions_section": {
"type": "boolean"
}
},
"type": "object"
},
"AlertRuleExport": {
"properties": {
"annotations": {
@@ -2744,6 +2752,14 @@
},
"type": "object"
},
"AlertRuleMetadata": {
"properties": {
"editor_settings": {
"$ref": "#/components/schemas/AlertRuleEditorSettings"
}
},
"type": "object"
},
"AlertRuleNotificationSettings": {
"properties": {
"group_by": {
@@ -6025,6 +6041,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/AlertRuleMetadata"
},
"namespace_uid": {
"type": "string"
},
@@ -6112,12 +6131,25 @@
},
"GettableRuleGroupConfig": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/components/schemas/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/components/schemas/GettableExtendedRuleNode"
@@ -8313,6 +8345,9 @@
"is_paused": {
"type": "boolean"
},
"metadata": {
"$ref": "#/components/schemas/AlertRuleMetadata"
},
"no_data_state": {
"enum": [
"Alerting",
@@ -8351,17 +8386,36 @@
},
"PostableRuleGroupConfig": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/components/schemas/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/components/schemas/PostableExtendedRuleNode"
},
"type": "array"
},
"source_tenants": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
@@ -9826,12 +9880,25 @@
},
"RuleGroupConfigResponse": {
"properties": {
"align_evaluation_time_on_interval": {
"type": "boolean"
},
"evaluation_delay": {
"type": "string"
},
"interval": {
"$ref": "#/components/schemas/Duration"
},
"limit": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"query_offset": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/components/schemas/GettableExtendedRuleNode"