vmalertmanagerconfig: add fields entity, actions and `update_aler…

…ts` for opsgenie_configs according to https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config. (#814)
VictoriaMetrics · Nov 23, 2023 · fec3f9d · fec3f9d
1 parent 45bfa36
commit fec3f9d
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 3 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/api/v1beta1/vmalertmanagerconfig_types.go b/api/v1beta1/vmalertmanagerconfig_types.go
@@ -654,6 +654,13 @@ type OpsGenieConfig struct {
 	// List of responders responsible for notifications.
 	// +optional
 	Responders []OpsGenieConfigResponder `json:"responders,omitempty"`
+	// Optional field that can be used to specify which domain alert is related to.
+	Entity string `json:"entity,omitempty"`
+	// Comma separated list of actions that will be available for the alert.
+	Actions string `json:"actions,omitempty"`
+	// Whether to update message and description of the alert in OpsGenie if it already exists
+	// By default, the alert is never updated in OpsGenie, the new message only appears in activity log.
+	UpdateAlerts bool `json:"update_alerts,omitempty"`
 	// HTTP client configuration.
 	// +optional
 	HTTPConfig *HTTPConfig `json:"http_config,omitempty"`

diff --git a/api/victoriametrics/v1beta1/additional.go b/api/victoriametrics/v1beta1/additional.go
@@ -581,7 +581,7 @@ func (l *License) IsProvided() bool {
 
 // MaybeAddToArgs conditionally adds license commandline args into given args
 func (l *License) MaybeAddToArgs(args []string, secretMountDir string) []string {
-	if !l.IsProvided() {
+	if l == nil || !l.IsProvided() {
 		return args
 	}
 	if l.Key != nil {
@@ -595,7 +595,7 @@ func (l *License) MaybeAddToArgs(args []string, secretMountDir string) []string
 
 // MaybeAddToVolumes conditionally mounts secret with license key into given volumes and mounts
 func (l *License) MaybeAddToVolumes(volumes []v1.Volume, mounts []v1.VolumeMount, secretMountDir string) ([]v1.Volume, []v1.VolumeMount) {
-	if l.KeyRef == nil {
+	if l == nil || l.KeyRef == nil {
 		return volumes, mounts
 	}
 	volumes = append(volumes, v1.Volume{

diff --git a/api/victoriametrics/v1beta1/vmagent_webhook_test.go b/api/victoriametrics/v1beta1/vmagent_webhook_test.go
@@ -60,6 +60,21 @@ func TestVMAgent_sanityCheck(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "relabeling with if array",
+			spec: VMAgentSpec{
+				RemoteWrite: []VMAgentRemoteWriteSpec{{URL: "http://some-rw"}},
+				InlineRelabelConfig: []RelabelConfig{
+					{
+						Action: "drop_metrics",
+						If: []string{
+							"{job=~\"aaa.*\"}",
+							"{job=~\"bbb.*\"}",
+						},
+					},
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

diff --git a/api/victoriametrics/v1beta1/vmalertmanagerconfig_types.go b/api/victoriametrics/v1beta1/vmalertmanagerconfig_types.go
@@ -654,6 +654,13 @@ type OpsGenieConfig struct {
 	// List of responders responsible for notifications.
 	// +optional
 	Responders []OpsGenieConfigResponder `json:"responders,omitempty"`
+	// Optional field that can be used to specify which domain alert is related to.
+	Entity string `json:"entity,omitempty"`
+	// Comma separated list of actions that will be available for the alert.
+	Actions string `json:"actions,omitempty"`
+	// Whether to update message and description of the alert in OpsGenie if it already exists
+	// By default, the alert is never updated in OpsGenie, the new message only appears in activity log.
+	UpdateAlerts bool `json:"update_alerts,omitempty"`
 	// HTTP client configuration.
 	// +optional
 	HTTPConfig *HTTPConfig `json:"http_config,omitempty"`

diff --git a/config/crd/bases/operator.victoriametrics.com_vmalertmanagerconfigs.yaml b/config/crd/bases/operator.victoriametrics.com_vmalertmanagerconfigs.yaml
@@ -377,6 +377,10 @@ spec:
                         description: OpsGenieConfig configures notifications via OpsGenie.
                           See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
                         properties:
+                          actions:
+                            description: Comma separated list of actions that will
+                              be available for the alert.
+                            type: string
                           api_key:
                             description: The secret's key that contains the OpsGenie
                               API key. It must be at them same namespace as CRD
@@ -410,6 +414,10 @@ spec:
                             description: A set of arbitrary key/value pairs that provide
                               further detail about the incident.
                             type: object
+                          entity:
+                            description: Optional field that can be used to specify
+                              which domain alert is related to.
+                            type: string
                           http_config:
                             description: HTTP client configuration.
                             type: object
@@ -459,6 +467,12 @@ spec:
                             description: Comma separated list of tags attached to
                               the notifications.
                             type: string
+                          update_alerts:
+                            description: Whether to update message and description
+                              of the alert in OpsGenie if it already exists By default,
+                              the alert is never updated in OpsGenie, the new message
+                              only appears in activity log.
+                            type: boolean
                         type: object
                       type: array
                     pagerduty_configs:

diff --git a/controllers/factory/alertmanager/config.go b/controllers/factory/alertmanager/config.go
@@ -957,6 +957,9 @@ func (cb *configBuilder) buildOpsGenie(og operatorv1beta1.OpsGenieConfig) error
 	toYamlString("tags", og.Tags)
 	toYamlString("note", og.Note)
 	toYamlString("api_url", og.APIURL)
+	toYamlString("entity", og.Entity)
+	toYamlString("Actions", og.Actions)
+
 	if og.APIURL != "" {
 		err := parseURL(og.APIURL)
 		if err != nil {
@@ -970,6 +973,9 @@ func (cb *configBuilder) buildOpsGenie(og operatorv1beta1.OpsGenieConfig) error
 	if og.SendResolved != nil {
 		temp = append(temp, yaml.MapItem{Key: "send_resolved", Value: *og.SendResolved})
 	}
+	if og.UpdateAlerts {
+		temp = append(temp, yaml.MapItem{Key: "update_alerts", Value: og.UpdateAlerts})
+	}
 
 	var responders []yaml.MapSlice
 	for _, responder := range og.Responders {

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -16,7 +16,7 @@ aliases:
 
 ## Next release
 
-- TODO
+- [vmalertmanagerconfig](./api.html#vmalertmanagerconfig): add fields `entity`, `actions` and `update_alerts` for opsgenie_configs according to https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config.
 
 <a name="v0.39.3"></a>
 ## [v0.39.3](https://github.com/VictoriaMetrics/operator/releases/tag/v0.39.3) - 16 Nov 2023