Skip to content

Alertmanager: Remove outdated comment #3216

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

Merged
merged 2 commits into from
Nov 20, 2020
Merged

Alertmanager: Remove outdated comment #3216

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
477a84d
Update comments for alertmanager failure modes
gotjosh Nov 18, 2020
4385603
[fixup] Inline transformConfig
gotjosh Nov 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions pkg/alertmanager/multitenant.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,9 +348,6 @@ func (am *MultitenantAlertmanager) syncConfigs(cfgs map[string]alerts.AlertConfi
}

func (am *MultitenantAlertmanager) transformConfig(userID string, amConfig *amconfig.Config) (*amconfig.Config, error) {
if amConfig == nil { // shouldn't happen, but check just in case
return nil, fmt.Errorf("no usable Cortex configuration for %v", userID)
}
if am.cfg.AutoWebhookRoot != "" {
for _, r := range amConfig.Receivers {
for _, w := range r.WebhookConfigs {
Expand Down Expand Up @@ -405,15 +402,21 @@ func (am *MultitenantAlertmanager) setConfig(cfg alerts.AlertConfigDesc) error {
} else {
userAmConfig, err = amconfig.Load(cfg.RawConfig)
if err != nil && hasExisting {
// XXX: This means that if a user has a working configuration and
// they submit a broken one, we'll keep processing the last known
// working configuration, and they'll never know.
// TODO: Provide a way of communicating this to the user and for removing
// Alertmanager instances.
// This means that if a user has a working config and
// they submit a broken one, the Manager will keep running the last known
// working configuration.
return fmt.Errorf("invalid Cortex configuration for %v: %v", cfg.User, err)
}
}

// We can have an empty configuration here if:
// 1) the user had a previous alertmanager
// 2) then, submitted a non-working configuration (and we kept running the prev working config)
// 3) finally, the cortex AM instance is restarted and the running version is no longer present
if userAmConfig == nil {
Copy link
Contributor

@jtlisi jtlisi Nov 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion(non-blocking,if-minor): Since this check has been moved from transformConfig consider removing the transformConfig function entirely an moving the for loop logic from the function here. transformConfig is only called here so it should be safe to move and I think it would still be quite readable as part of a single function call.

return fmt.Errorf("no usable Alertmanager configuration for %v", cfg.User)
}

if userAmConfig, err = am.transformConfig(cfg.User, userAmConfig); err != nil {
return err
}
Expand Down