Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

alertmanager: add missing types #5876

Merged
merged 6 commits into from
Sep 11, 2023
Merged

alertmanager: add missing types #5876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9cb0860
alertmanager: add missing types
Sep 1, 2023
7f83888
pkg/alertmanager: add BotTokenFile to telegramConfig
Sep 1, 2023
e20bf9e
pkg/alertmanager: add input sanitize and unit test
Sep 1, 2023
764a6cd
fix format
Sep 1, 2023
8d02a0c
pkg/alertmanger: remove changes for telegram bot_toke_file
Sep 4, 2023
6caa84b
pkg/alertmanager: revert name change in telegramconfig
Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
50 changes: 48 additions & 2 deletions pkg/alertmanager/amcfg.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1917,7 +1917,37 @@ func (pdc *pagerdutyConfig) sanitize(amVersion semver.Version, logger log.Logger
}

func (poc *pushoverConfig) sanitize(amVersion semver.Version, logger log.Logger) error {
return poc.HTTPConfig.sanitize(amVersion, logger)
if err := poc.HTTPConfig.sanitize(amVersion, logger); err != nil {
return err
}

lessThanV0_26 := amVersion.LT(semver.MustParse("0.26.0"))

if poc.UserKeyFile != "" && lessThanV0_26 {
msg := "'user_key_file' supported in Alertmanager >= 0.26.0 only - dropping field from provided config"
level.Warn(logger).Log("msg", msg, "current_version", amVersion.String())
poc.UserKeyFile = ""
}

if poc.TokenFile != "" && lessThanV0_26 {
msg := "'token_file' supported in Alertmanager >= 0.26.0 only - dropping field from provided config"
level.Warn(logger).Log("msg", msg, "current_version", amVersion.String())
poc.TokenFile = ""
}

if poc.UserKey != "" && poc.UserKeyFile != "" {
msg := "'user_key' and 'user_key_file' are mutually exclusive for pushover receiver config - 'user_key' has taken precedence"
level.Warn(logger).Log("msg", msg)
poc.UserKeyFile = ""
}

if poc.Token != "" && poc.TokenFile != "" {
msg := "'token' and 'token_file' are mutually exclusive for pushover receiver config - 'token' has taken precedence"
level.Warn(logger).Log("msg", msg)
poc.TokenFile = ""
}

return nil
}

func (sc *slackConfig) sanitize(amVersion semver.Version, logger log.Logger) error {
Expand Down Expand Up @@ -1967,7 +1997,23 @@ func (voc *victorOpsConfig) sanitize(amVersion semver.Version, logger log.Logger
}

func (whc *webhookConfig) sanitize(amVersion semver.Version, logger log.Logger) error {
return whc.HTTPConfig.sanitize(amVersion, logger)
if err := whc.HTTPConfig.sanitize(amVersion, logger); err != nil {
return err
}

if whc.URLFile != "" && amVersion.LT(semver.MustParse("0.26.0")) {
msg := "'url_file' supported in Alertmanager >= 0.26.0 only - dropping field from provided config"
level.Warn(logger).Log("msg", msg, "current_version", amVersion.String())
whc.URLFile = ""
}

if whc.URL != "" && whc.URLFile != "" {
msg := "'url' and 'url_file' are mutually exclusive for webhook receiver config - 'url' has taken precedence"
level.Warn(logger).Log("msg", msg)
whc.URLFile = ""
}

return nil
}

func (wcc *weChatConfig) sanitize(amVersion semver.Version, logger log.Logger) error {
Expand Down
217 changes: 217 additions & 0 deletions pkg/alertmanager/amcfg_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2982,6 +2982,223 @@ func TestSanitizeVictorOpsConfig(t *testing.T) {
}
}

func TestSanitizeWebhookConfig(t *testing.T) {
logger := log.NewNopLogger()

for _, tc := range []struct {
name string
againstVersion semver.Version
in *alertmanagerConfig
expect alertmanagerConfig
expectErr bool
}{
{
name: "Test webhook_url_file is dropped in webhook config for unsupported versions",
againstVersion: semver.Version{Major: 0, Minor: 25},
in: &alertmanagerConfig{
Receivers: []*receiver{
{
WebhookConfigs: []*webhookConfig{
{
URLFile: "foo",
},
},
},
},
},
expect: alertmanagerConfig{
Receivers: []*receiver{
{
WebhookConfigs: []*webhookConfig{
{
URLFile: "",
},
},
},
},
},
},
{
name: "Test url takes precedence in webhook config",
againstVersion: semver.Version{Major: 0, Minor: 26},
in: &alertmanagerConfig{
Receivers: []*receiver{
{
WebhookConfigs: []*webhookConfig{
{
URL: "foo",
URLFile: "bar",
},
},
},
},
},
expect: alertmanagerConfig{
Receivers: []*receiver{
{
WebhookConfigs: []*webhookConfig{
{
URL: "foo",
},
},
},
},
},
},
} {
t.Run(tc.name, func(t *testing.T) {
err := tc.in.sanitize(tc.againstVersion, logger)
if tc.expectErr {
if err == nil {
t.Fatal("expected error but got none")
}
return
}

if err != nil {
t.Fatalf("expected no error but got: %q", err)
}

require.Equal(t, tc.expect, *tc.in)
})
}
}

func TestSanitizePushoverConfig(t *testing.T) {
logger := log.NewNopLogger()

for _, tc := range []struct {
name string
againstVersion semver.Version
in *alertmanagerConfig
expect alertmanagerConfig
expectErr bool
}{
{
name: "Test pushover_user_key_file is dropped in pushover config for unsupported versions",
againstVersion: semver.Version{Major: 0, Minor: 25},
in: &alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
UserKeyFile: "foo",
},
},
},
},
},
expect: alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
UserKeyFile: "",
},
},
},
},
},
},
{
name: "Test pushover_token_file is dropped in pushover config for unsupported versions",
againstVersion: semver.Version{Major: 0, Minor: 25},
in: &alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
TokenFile: "foo",
},
},
},
},
},
expect: alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
TokenFile: "",
},
},
},
},
},
},
{
name: "Test user_key takes precedence in pushover config",
againstVersion: semver.Version{Major: 0, Minor: 26},
in: &alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
UserKey: "foo",
UserKeyFile: "bar",
},
},
},
},
},
expect: alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
UserKey: "foo",
},
},
},
},
},
},
{
name: "Test token takes precedence in pushover config",
againstVersion: semver.Version{Major: 0, Minor: 26},
in: &alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
Token: "foo",
TokenFile: "bar",
},
},
},
},
},
expect: alertmanagerConfig{
Receivers: []*receiver{
{
PushoverConfigs: []*pushoverConfig{
{
Token: "foo",
},
},
},
},
},
},
} {
t.Run(tc.name, func(t *testing.T) {
err := tc.in.sanitize(tc.againstVersion, logger)
if tc.expectErr {
if err == nil {
t.Fatal("expected error but got none")
}
return
}

if err != nil {
t.Fatalf("expected no error but got: %q", err)
}

require.Equal(t, tc.expect, *tc.in)
})
}
}

func TestSanitizePagerDutyConfig(t *testing.T) {
logger := log.NewNopLogger()

Expand Down
3 changes: 3 additions & 0 deletions pkg/alertmanager/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ type receiver struct {
type webhookConfig struct {
VSendResolved *bool `yaml:"send_resolved,omitempty" json:"send_resolved,omitempty"`
URL string `yaml:"url,omitempty" json:"url,omitempty"`
URLFile string `yaml:"url_file,omitempty" json:"url_file,omitempty"`
HTTPConfig *httpClientConfig `yaml:"http_config,omitempty" json:"http_config,omitempty"`
MaxAlerts int32 `yaml:"max_alerts,omitempty" json:"max_alerts,omitempty"`
}
Expand Down Expand Up @@ -308,7 +309,9 @@ type pushoverConfig struct {
VSendResolved *bool `yaml:"send_resolved,omitempty" json:"send_resolved,omitempty"`
HTTPConfig *httpClientConfig `yaml:"http_config,omitempty" json:"http_config,omitempty"`
UserKey string `yaml:"user_key,omitempty" json:"user_key,omitempty"`
UserKeyFile string `yaml:"user_key_file,omitempty" json:"user_key_file,omitempty"`
Token string `yaml:"token,omitempty" json:"token,omitempty"`
TokenFile string `yaml:"token_file,omitempty" json:"token_file,omitempty"`
Title string `yaml:"title,omitempty" json:"title,omitempty"`
Message string `yaml:"message,omitempty" json:"message,omitempty"`
URL string `yaml:"url,omitempty" json:"url,omitempty"`
Expand Down