mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-21 03:38:43 +00:00
Code Activity

feat: Support Jira and RocketChat receivers in Alertmanager config secret

Browse source 
Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>
This commit is contained in:
Jayapriya Pai 2025-02-04 12:45:39 +05:30
parent 9716e268da
commit 1cdc040473
No known key found for this signature in database
GPG key ID: 3E100BB6BD29148E
6 changed files with 308 additions and 15 deletions

1
CHANGELOG.md
View file

@ -5,6 +5,7 @@
* [FEATURE] Add `keepIdentifyingResourceAttributes` field in OTLPConfig for `Prometheus` and `PrometheusAgent` CRDs. #7240
* [FEATURE] Add `fallbackScrapeProtocol` field to ScrapeClass for `Prometheus` and `PrometheusAgent` CRDs. #7288
* [FEATURE] Support `MSTeamsV2Config` receiver in Alertmanager configuration Secret. #7296
* [FEATURE] Support `JiraConfig` and `RocketChat` receivers in Alertmanager configuration secret. #7315
* [FEATURE] Add `timeout` field in Webhook receiver in Alertmanager configuration Secret. #7312
* [FEATURE] Add `content`, `username` and `avatarUrl` fields in Discord receiver in Alertmanager configuration secret. #7313
* [FEATURE] Add `scrapeFailureLogFile` field to the Prometheus and PrometheusAgent CRDs. #7038 #7311

43
pkg/alertmanager/amcfg.go
View file

@ -2018,6 +2018,17 @@ func (r *receiver) sanitize(amVersion semver.Version, logger *slog.Logger) error
}
}
for _, conf := range r.JiraConfigs {
if err := conf.sanitize(amVersion, withLogger); err != nil {
return err
}
}
for _, conf := range r.RocketChatConfigs {
if err := conf.sanitize(amVersion, withLogger); err != nil {
return err
}
}
return nil
}
@ -2371,6 +2382,38 @@ func (tc *webexConfig) sanitize(amVersion semver.Version, logger *slog.Logger) e
return tc.HTTPConfig.sanitize(amVersion, logger)
}
func (jc *jiraConfig) sanitize(amVersion semver.Version, logger *slog.Logger) error {
jiraConfigAllowed := amVersion.GTE(semver.MustParse("0.28.0"))
if !jiraConfigAllowed {
return fmt.Errorf(`invalid syntax in receivers config; jira integration is available in Alertmanager >= 0.28.0`)
}
if jc.Project == "" {
return fmt.Errorf("missing project in jira_config")
}
if jc.IssueType == "" {
return errors.New("missing issue_type in jira_config")
}
return jc.HTTPConfig.sanitize(amVersion, logger)
}
func (rc *rocketChatConfig) sanitize(amVersion semver.Version, logger *slog.Logger) error {
rocketChatAllowed := amVersion.GTE(semver.MustParse("0.28.0"))
if !rocketChatAllowed {
return fmt.Errorf(`invalid syntax in receivers config; rocketchat integration is available in Alertmanager >= 0.28.0`)
}
if rc.Token != nil && len(rc.TokenFile) > 0 {
return fmt.Errorf("at most one of token & token_file must be configured")
}
if rc.TokenID != nil && len(rc.TokenIDFile) > 0 {
return fmt.Errorf("at most one of token_id & token_id_file must be configured")
}
return rc.HTTPConfig.sanitize(amVersion, logger)
}
func (ir *inhibitRule) sanitize(amVersion semver.Version, logger *slog.Logger) error {
matchersV2Allowed := amVersion.GTE(semver.MustParse("0.22.0"))

176
pkg/alertmanager/amcfg_test.go
View file

@ -4013,6 +4013,182 @@ func TestSanitizePagerDutyConfig(t *testing.T) {
}
}
func TestSanitizeJiraConfig(t *testing.T) {
logger := newNopLogger(t)
versionJiraAllowed := semver.Version{Major: 0, Minor: 28}
versionJiraNotAllowed := semver.Version{Major: 0, Minor: 27}
for _, tc := range []struct {
name string
againstVersion semver.Version
in *alertmanagerConfig
golden string
expectErr bool
}{
{
name: "jira_configs returns error for unsupported versions",
againstVersion: versionJiraNotAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
JiraConfigs: []*jiraConfig{
{
APIURL: "http://example.com",
},
},
},
},
},
expectErr: true,
},
{
name: "jira_configs allows for supported versions",
againstVersion: versionJiraAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
JiraConfigs: []*jiraConfig{
{
APIURL: "http://issues.example.com",
Project: "Monitoring",
IssueType: "Bug",
},
},
},
},
},
golden: "jira_configs_for_supported_versions.golden",
},
{
name: "jira_configs returns error for missing mandatory fields",
againstVersion: versionJiraAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
JiraConfigs: []*jiraConfig{
{
APIURL: "http://example.com",
},
},
},
},
},
expectErr: true,
},
} {
t.Run(tc.name, func(t *testing.T) {
err := tc.in.sanitize(tc.againstVersion, logger)
if tc.expectErr {
require.Error(t, err)
return
}
require.NoError(t, err)
amConfigs, err := yaml.Marshal(tc.in)
require.NoError(t, err)
golden.Assert(t, string(amConfigs), tc.golden)
})
}
}
func TestSanitizeRocketChatConfig(t *testing.T) {
logger := newNopLogger(t)
versionRocketChatAllowed := semver.Version{Major: 0, Minor: 28}
versionRocketChatNotAllowed := semver.Version{Major: 0, Minor: 27}
for _, tc := range []struct {
name string
againstVersion semver.Version
in *alertmanagerConfig
golden string
expectErr bool
}{
{
name: "rocketchat_configs returns error for unsupported versions",
againstVersion: versionRocketChatNotAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
RocketChatConfigs: []*rocketChatConfig{
{
APIURL: "http://example.com",
},
},
},
},
},
expectErr: true,
},
{
name: "rocketchat_configs allows for supported versions",
againstVersion: versionRocketChatAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
RocketChatConfigs: []*rocketChatConfig{
{
APIURL: "http://example.com",
},
},
},
},
},
golden: "rocketchat_configs_for_supported_versions.golden",
},
{
name: "rocketchat_configs both token or token_file set",
againstVersion: versionRocketChatAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
RocketChatConfigs: []*rocketChatConfig{
{
APIURL: "http://example.com",
Token: ptr.To("aaaa-bbbb-cccc-dddd"),
TokenFile: "/var/kubernetes/secrets/token",
},
},
},
},
},
expectErr: true,
},
{
name: "rocketchat_configs both token_id or token_id_file set",
againstVersion: versionRocketChatAllowed,
in: &alertmanagerConfig{
Receivers: []*receiver{
{
RocketChatConfigs: []*rocketChatConfig{
{
APIURL: "http://example.com",
TokenID: ptr.To("t123456"),
TokenIDFile: "/var/kubernetes/secrets/token-id",
},
},
},
},
},
expectErr: true,
},
} {
t.Run(tc.name, func(t *testing.T) {
err := tc.in.sanitize(tc.againstVersion, logger)
if tc.expectErr {
require.Error(t, err)
return
}
require.NoError(t, err)
amConfigs, err := yaml.Marshal(tc.in)
require.NoError(t, err)
golden.Assert(t, string(amConfigs), tc.golden)
})
}
}
func TestSanitizeRoute(t *testing.T) {
logger := newNopLogger(t)
matcherV2SyntaxAllowed := semver.Version{Major: 0, Minor: 22}

7
pkg/alertmanager/testdata/jira_configs_for_supported_versions.golden generated vendored Normal file
View file

@ -0,0 +1,7 @@
receivers:
- name: ""
jira_configs:
- api_url: http://issues.example.com
project: Monitoring
issue_type: Bug
templates: []

7
pkg/alertmanager/testdata/rocketchat_configs_for_supported_versions.golden generated vendored Normal file
View file

@ -0,0 +1,7 @@
receivers:
- name: ""
rocketchat_configs:
- api_url: http://example.com
short_fields: false
link_names: false
templates: []

89
pkg/alertmanager/types.go
View file

@ -97,21 +97,23 @@ type inhibitRule struct {
}
type receiver struct {
Name string `yaml:"name" json:"name"`
OpsgenieConfigs []*opsgenieConfig `yaml:"opsgenie_configs,omitempty" json:"opsgenie_configs,omitempty"`
PagerdutyConfigs []*pagerdutyConfig `yaml:"pagerduty_configs,omitempty" json:"pagerduty_configs,omitempty"`
SlackConfigs []*slackConfig `yaml:"slack_configs,omitempty" json:"slack_configs,omitempty"`
WebhookConfigs []*webhookConfig `yaml:"webhook_configs,omitempty" json:"webhook_configs,omitempty"`
WeChatConfigs []*weChatConfig `yaml:"wechat_configs,omitempty" json:"wechat_config,omitempty"`
EmailConfigs []*emailConfig `yaml:"email_configs,omitempty" json:"email_configs,omitempty"`
PushoverConfigs []*pushoverConfig `yaml:"pushover_configs,omitempty" json:"pushover_configs,omitempty"`
VictorOpsConfigs []*victorOpsConfig `yaml:"victorops_configs,omitempty" json:"victorops_configs,omitempty"`
SNSConfigs []*snsConfig `yaml:"sns_configs,omitempty" json:"sns_configs,omitempty"`
TelegramConfigs []*telegramConfig `yaml:"telegram_configs,omitempty" json:"telegram_configs,omitempty"`
DiscordConfigs []*discordConfig `yaml:"discord_configs,omitempty"`
WebexConfigs []*webexConfig `yaml:"webex_configs,omitempty"`
MSTeamsConfigs []*msTeamsConfig `yaml:"msteams_configs,omitempty"`
MSTeamsV2Configs []*msTeamsV2Config `yaml:"msteamsv2_configs,omitempty"`
Name string `yaml:"name" json:"name"`
OpsgenieConfigs []*opsgenieConfig `yaml:"opsgenie_configs,omitempty" json:"opsgenie_configs,omitempty"`
PagerdutyConfigs []*pagerdutyConfig `yaml:"pagerduty_configs,omitempty" json:"pagerduty_configs,omitempty"`
SlackConfigs []*slackConfig `yaml:"slack_configs,omitempty" json:"slack_configs,omitempty"`
WebhookConfigs []*webhookConfig `yaml:"webhook_configs,omitempty" json:"webhook_configs,omitempty"`
WeChatConfigs []*weChatConfig `yaml:"wechat_configs,omitempty" json:"wechat_config,omitempty"`
EmailConfigs []*emailConfig `yaml:"email_configs,omitempty" json:"email_configs,omitempty"`
PushoverConfigs []*pushoverConfig `yaml:"pushover_configs,omitempty" json:"pushover_configs,omitempty"`
VictorOpsConfigs []*victorOpsConfig `yaml:"victorops_configs,omitempty" json:"victorops_configs,omitempty"`
SNSConfigs []*snsConfig `yaml:"sns_configs,omitempty" json:"sns_configs,omitempty"`
TelegramConfigs []*telegramConfig `yaml:"telegram_configs,omitempty" json:"telegram_configs,omitempty"`
DiscordConfigs []*discordConfig `yaml:"discord_configs,omitempty"`
WebexConfigs []*webexConfig `yaml:"webex_configs,omitempty"`
MSTeamsConfigs []*msTeamsConfig `yaml:"msteams_configs,omitempty"`
MSTeamsV2Configs []*msTeamsV2Config `yaml:"msteamsv2_configs,omitempty"`
JiraConfigs []*jiraConfig `yaml:"jira_configs,omitempty"`
RocketChatConfigs []*rocketChatConfig `yaml:"rocketchat_configs,omitempty"`
}
type webhookConfig struct {
@ -435,4 +437,61 @@ type msTeamsV2Config struct {
HTTPConfig *httpClientConfig `yaml:"http_config,omitempty"`
}
type jiraConfig struct {
HTTPConfig *httpClientConfig `yaml:"http_config,omitempty"`
APIURL string `yaml:"api_url,omitempty"`
Project string `yaml:"project,omitempty"`
Summary string `yaml:"summary,omitempty"`
Description string `yaml:"description,omitempty"`
Labels []string `yaml:"labels,omitempty"`
Priority string `yaml:"priority,omitempty"`
IssueType string `yaml:"issue_type,omitempty"`
ReopenTransition string `yaml:"reopen_transition,omitempty"`
ResolveTransition string `yaml:"resolve_transition,omitempty"`
WontFixResolution string `yaml:"wont_fix_resolution,omitempty"`
ReopenDuration model.Duration `yaml:"reopen_duration,omitempty"`
Fields map[string]any `yaml:"fields,omitempty"`
}
type rocketchatAttachmentField struct {
Short *bool `yaml:"short"`
Title string `yaml:"title,omitempty"`
Value string `yaml:"value,omitempty"`
}
type rocketchatAttachmentAction struct {
Type string `yaml:"type,omitempty"`
Text string `yaml:"text,omitempty"`
URL string `yaml:"url,omitempty"`
ImageURL string `yaml:"image_url,omitempty"`
IsWebView bool `yaml:"is_webview"`
WebviewHeightRatio string `yaml:"webview_height_ratio,omitempty"`
Msg string `yaml:"msg,omitempty"`
MsgInChatWindow bool `yaml:"msg_in_chat_window"`
MsgProcessingType string `yaml:"msg_processing_type,omitempty"`
}
type rocketChatConfig struct {
HTTPConfig *httpClientConfig `yaml:"http_config,omitempty"`
APIURL string `yaml:"api_url,omitempty"`
TokenID *string `yaml:"token_id,omitempty"`
TokenIDFile string `yaml:"token_id_file,omitempty"`
Token *string `yaml:"token,omitempty"`
TokenFile string `yaml:"token_file,omitempty"`
// RocketChat channel override, (like #other-channel or @username).
Channel string `yaml:"channel,omitempty"`
Color string `yaml:"color,omitempty"`
Title string `yaml:"title,omitempty"`
TitleLink string `yaml:"title_link,omitempty"`
Text string `yaml:"text,omitempty"`
Fields []*rocketchatAttachmentField `yaml:"fields,omitempty"`
ShortFields bool `yaml:"short_fields"`
Emoji string `yaml:"emoji,omitempty"`
IconURL string `yaml:"icon_url,omitempty"`
ImageURL string `yaml:"image_url,omitempty"`
ThumbURL string `yaml:"thumb_url,omitempty"`
LinkNames bool `yaml:"link_names"`
Actions []*rocketchatAttachmentAction `yaml:"actions,omitempty"`
}
type timeInterval config.TimeInterval