Skip to content

Removed alertmanager flags deprecated in Cortex 1.7 #3946

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 1 commit into from
Mar 15, 2021
Merged

Removed alertmanager flags deprecated in Cortex 1.7 #3946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

* [CHANGE] Alertmanager now removes local files after Alertmanager is no longer running for removed or resharded user. #3910
* [CHANGE] Alertmanager now stores local files in per-tenant folders. Files stored by Alertmanager previously are migrated to new hierarchy. Support for this migration will be removed in Cortex 1.10. #3910
* [CHANGE] Alertmanager: removed `-cluster.` CLI flags deprecated in Cortex 1.7. The new config options to use are: #3946
* `-alertmanager.cluster.listen-address` instead of `-cluster.listen-address`
* `-alertmanager.cluster.advertise-address` instead of `-cluster.advertise-address`
* `-alertmanager.cluster.peers` instead of `-cluster.peer`
* `-alertmanager.cluster.peer-timeout` instead of `-cluster.peer-timeout`
* [FEATURE] Ruler Storage: Added `local` backend support to the ruler storage configuration under the `-ruler-storage.` flag prefix. #3932
* [ENHANCEMENT] Ruler: optimized `<prefix>/api/v1/rules` and `<prefix>/api/v1/alerts` when ruler sharding is enabled. #3916
* [ENHANCEMENT] Ruler: added the following metrics when ruler sharding is enabled: #3916
Expand Down
16 changes: 0 additions & 16 deletions docs/configuration/config-file-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1997,22 +1997,6 @@ The `alertmanager_config` configures the Cortex alertmanager.
# CLI flag: -alertmanager.max-recv-msg-size
[max_recv_msg_size: <int> | default = 16777216]

# Deprecated. Use -alertmanager.cluster.listen-address instead.
# CLI flag: -cluster.listen-address
[cluster_bind_address: <string> | default = "0.0.0.0:9094"]

# Deprecated. Use -alertmanager.cluster.advertise-address instead.
# CLI flag: -cluster.advertise-address
[cluster_advertise_address: <string> | default = ""]

# Deprecated. Use -alertmanager.cluster.peers instead.
# CLI flag: -cluster.peer
[peers: <list of string> | default = []]

# Deprecated. Use -alertmanager.cluster.peer-timeout instead.
# CLI flag: -cluster.peer-timeout
[peer_timeout: <duration> | default = 15s]

# Shard tenants across multiple alertmanager instances.
# CLI flag: -alertmanager.sharding-enabled
[sharding_enabled: <boolean> | default = false]
Expand Down
41 changes: 0 additions & 41 deletions pkg/alertmanager/multitenant.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,6 @@ type MultitenantAlertmanagerConfig struct {
PollInterval time.Duration `yaml:"poll_interval"`
MaxRecvMsgSize int64 `yaml:"max_recv_msg_size"`

DeprecatedClusterBindAddr string `yaml:"cluster_bind_address"`
DeprecatedClusterAdvertiseAddr string `yaml:"cluster_advertise_address"`
DeprecatedPeers flagext.StringSlice `yaml:"peers"`
DeprecatedPeerTimeout time.Duration `yaml:"peer_timeout"`

// Enable sharding for the Alertmanager
ShardingEnabled bool `yaml:"sharding_enabled"`
ShardingRing RingConfig `yaml:"sharding_ring"`
Expand Down Expand Up @@ -152,13 +147,6 @@ func (cfg *MultitenantAlertmanagerConfig) RegisterFlags(f *flag.FlagSet) {
f.StringVar(&cfg.AutoWebhookRoot, "alertmanager.configs.auto-webhook-root", "", "Root of URL to generate if config is "+autoWebhookURL)
f.DurationVar(&cfg.PollInterval, "alertmanager.configs.poll-interval", 15*time.Second, "How frequently to poll Cortex configs")

// Flags prefixed with `cluster` are deprecated in favor of their `alertmanager` prefix equivalent.
// TODO: New flags introduced in Cortex 1.7, remove old ones in Cortex 1.9
f.StringVar(&cfg.DeprecatedClusterBindAddr, "cluster.listen-address", defaultClusterAddr, "Deprecated. Use -alertmanager.cluster.listen-address instead.")
f.StringVar(&cfg.DeprecatedClusterAdvertiseAddr, "cluster.advertise-address", "", "Deprecated. Use -alertmanager.cluster.advertise-address instead.")
f.Var(&cfg.DeprecatedPeers, "cluster.peer", "Deprecated. Use -alertmanager.cluster.peers instead.")
f.DurationVar(&cfg.DeprecatedPeerTimeout, "cluster.peer-timeout", time.Second*15, "Deprecated. Use -alertmanager.cluster.peer-timeout instead.")

f.BoolVar(&cfg.EnableAPI, "experimental.alertmanager.enable-api", false, "Enable the experimental alertmanager config api.")

f.BoolVar(&cfg.ShardingEnabled, "alertmanager.sharding-enabled", false, "Shard tenants across multiple alertmanager instances.")
Expand All @@ -180,33 +168,6 @@ func (cfg *ClusterConfig) RegisterFlags(f *flag.FlagSet) {
f.DurationVar(&cfg.PushPullInterval, prefix+"push-pull-interval", cluster.DefaultPushPullInterval, "The interval between gossip state syncs. Setting this interval lower (more frequent) will increase convergence speeds across larger clusters at the expense of increased bandwidth usage.")
}

// SupportDeprecatedFlagset ensures we support the previous set of cluster flags that are now deprecated.
func (cfg *ClusterConfig) SupportDeprecatedFlagset(amCfg *MultitenantAlertmanagerConfig, logger log.Logger) {
if amCfg.DeprecatedClusterBindAddr != defaultClusterAddr {
flagext.DeprecatedFlagsUsed.Inc()
level.Warn(logger).Log("msg", "running with DEPRECATED flag -cluster.listen-address, use -alertmanager.cluster.listen-address instead.")
cfg.ListenAddr = amCfg.DeprecatedClusterBindAddr
}

if amCfg.DeprecatedClusterAdvertiseAddr != "" {
flagext.DeprecatedFlagsUsed.Inc()
level.Warn(logger).Log("msg", "running with DEPRECATED flag -cluster.advertise-address, use -alertmanager.cluster.advertise-address instead.")
cfg.AdvertiseAddr = amCfg.DeprecatedClusterAdvertiseAddr
}

if len(amCfg.DeprecatedPeers) > 0 {
flagext.DeprecatedFlagsUsed.Inc()
level.Warn(logger).Log("msg", "running with DEPRECATED flag -cluster.peer, use -alertmanager.cluster.peers instead.")
cfg.Peers = []string(amCfg.DeprecatedPeers)
}

if amCfg.DeprecatedPeerTimeout != defaultPeerTimeout {
flagext.DeprecatedFlagsUsed.Inc()
level.Warn(logger).Log("msg", "running with DEPRECATED flag -cluster.peer-timeout, use -alertmanager.cluster.peer-timeout instead.")
cfg.PeerTimeout = amCfg.DeprecatedPeerTimeout
}
}

// Validate config and returns error on failure
func (cfg *MultitenantAlertmanagerConfig) Validate() error {
if err := cfg.Store.Validate(); err != nil {
Expand Down Expand Up @@ -311,8 +272,6 @@ func NewMultitenantAlertmanager(cfg *MultitenantAlertmanagerConfig, store alerts
}
}

cfg.Cluster.SupportDeprecatedFlagset(cfg, logger)

var peer *cluster.Peer
// We need to take this case into account to support our legacy upstream clustering.
if cfg.Cluster.ListenAddr != "" && !cfg.ShardingEnabled {
Expand Down