From 10b4dfbbf9d0750fd5ef95acd16d665dc630e478 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 22 Nov 2023 20:06:11 +0200 Subject: [PATCH] app/vmalert/notifier: remove backticks from the description for -notifier.blackhole command-line flag Backticks in flag description are automatically converted to flag type. See https://pkg.go.dev/flag#PrintDefaults This is a follow-up for 20025d4fd69cdad12e194e4fefa61afd2155082e and 25317b4e7012c20b1f817b922d8f7dbdcdfd0327 --- app/vmalert/notifier/init.go | 2 +- docs/vmalert.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/app/vmalert/notifier/init.go b/app/vmalert/notifier/init.go index f1e5cabca7..6972effb9c 100644 --- a/app/vmalert/notifier/init.go +++ b/app/vmalert/notifier/init.go @@ -23,7 +23,7 @@ var ( "It is hidden by default, since it can contain sensitive info such as auth key") blackHole = flag.Bool("notifier.blackhole", false, "Whether to blackhole alerting notifications. "+ "Enable this flag if you want vmalert to evaluate alerting rules without sending any notifications to external receivers (eg. alertmanager). "+ - "`-notifier.url`, `-notifier.config` and `-notifier.blackhole` are mutually exclusive.") + "-notifier.url, -notifier.config and -notifier.blackhole are mutually exclusive.") basicAuthUsername = flagutil.NewArrayString("notifier.basicAuth.username", "Optional basic auth username for -notifier.url") basicAuthPassword = flagutil.NewArrayString("notifier.basicAuth.password", "Optional basic auth password for -notifier.url") diff --git a/docs/vmalert.md b/docs/vmalert.md index 316c0a0cfb..4ebf795506 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -1138,8 +1138,8 @@ The shortlist of configuration flags is the following: -notifier.bearerTokenFile array Optional path to bearer token file for -notifier.url Supports an array of values separated by comma or specified via multiple flags. - -notifier.blackhole bool - Whether to blackhole alerting notifications. Enable this flag if you want vmalert to evaluate alerting rules without sending any notifications to external receivers (eg. alertmanager). -notifier.url, `-notifier.config` and `-notifier.blackhole` are mutually exclusive. + -notifier.blackhole + Whether to blackhole alerting notifications. Enable this flag if you want vmalert to evaluate alerting rules without sending any notifications to external receivers (eg. alertmanager). -notifier.url, -notifier.config and -notifier.blackhole are mutually exclusive. -notifier.config string Path to configuration file for notifiers -notifier.oauth2.clientID array