From 42864bb52f1d0b81cbb321bbec5554b7f30d7357 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin <valyala@gmail.com> Date: Tue, 4 Feb 2020 15:46:13 +0200 Subject: [PATCH] all: do not clash flag description with back-quoted flag types See https://golang.org/pkg/flag/#PrintDefaults for more details. --- app/victoria-metrics/self_scraper.go | 2 +- app/vminsert/concurrencylimiter/concurrencylimiter.go | 4 ++-- app/vminsert/influx/request_handler.go | 4 ++-- app/vminsert/vmimport/request_handler.go | 2 +- app/vmrestore/main.go | 2 +- app/vmselect/main.go | 4 ++-- app/vmselect/prometheus/prometheus.go | 6 +++--- lib/backup/actions/restore.go | 2 +- lib/fs/reader_at.go | 2 +- lib/httpserver/httpserver.go | 6 +++--- lib/storage/dedup.go | 2 +- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/app/victoria-metrics/self_scraper.go b/app/victoria-metrics/self_scraper.go index 624a168c83..c2564d502a 100644 --- a/app/victoria-metrics/self_scraper.go +++ b/app/victoria-metrics/self_scraper.go @@ -14,7 +14,7 @@ import ( "github.com/VictoriaMetrics/VictoriaMetrics/lib/storage" ) -var selfScrapeInterval = flag.Duration("selfScrapeInterval", 0, "Interval for self-scraping own metrics at `/metrics` page") +var selfScrapeInterval = flag.Duration("selfScrapeInterval", 0, "Interval for self-scraping own metrics at /metrics page") var selfScraperStopCh chan struct{} var selfScraperWG sync.WaitGroup diff --git a/app/vminsert/concurrencylimiter/concurrencylimiter.go b/app/vminsert/concurrencylimiter/concurrencylimiter.go index d94deee9fd..079bf03f47 100644 --- a/app/vminsert/concurrencylimiter/concurrencylimiter.go +++ b/app/vminsert/concurrencylimiter/concurrencylimiter.go @@ -13,8 +13,8 @@ import ( ) var ( - maxConcurrentInserts = flag.Int("maxConcurrentInserts", runtime.GOMAXPROCS(-1)*4, "The maximum number of concurrent inserts; see also `-insert.maxQueueDuration`") - maxQueueDuration = flag.Duration("insert.maxQueueDuration", time.Minute, "The maximum duration for waiting in the queue for insert requests due to `-maxConcurrentInserts`") + maxConcurrentInserts = flag.Int("maxConcurrentInserts", runtime.GOMAXPROCS(-1)*4, "The maximum number of concurrent inserts; see also -insert.maxQueueDuration") + maxQueueDuration = flag.Duration("insert.maxQueueDuration", time.Minute, "The maximum duration for waiting in the queue for insert requests due to -maxConcurrentInserts") ) // ch is the channel for limiting concurrent calls to Do. diff --git a/app/vminsert/influx/request_handler.go b/app/vminsert/influx/request_handler.go index 1453ccdbb5..ee223a8a6b 100644 --- a/app/vminsert/influx/request_handler.go +++ b/app/vminsert/influx/request_handler.go @@ -18,8 +18,8 @@ import ( ) var ( - measurementFieldSeparator = flag.String("influxMeasurementFieldSeparator", "_", "Separator for `{measurement}{separator}{field_name}` metric name when inserted via Influx line protocol") - skipSingleField = flag.Bool("influxSkipSingleField", false, "Uses `{measurement}` instead of `{measurement}{separator}{field_name}` for metic name if Influx line contains only a single field") + measurementFieldSeparator = flag.String("influxMeasurementFieldSeparator", "_", "Separator for '{measurement}{separator}{field_name}' metric name when inserted via Influx line protocol") + skipSingleField = flag.Bool("influxSkipSingleField", false, "Uses '{measurement}' instead of '{measurement}{separator}{field_name}' for metic name if Influx line contains only a single field") ) var ( diff --git a/app/vminsert/vmimport/request_handler.go b/app/vminsert/vmimport/request_handler.go index d6fd768027..9e82d4e6cc 100644 --- a/app/vminsert/vmimport/request_handler.go +++ b/app/vminsert/vmimport/request_handler.go @@ -15,7 +15,7 @@ import ( "github.com/VictoriaMetrics/metrics" ) -var maxLineLen = flag.Int("import.maxLineLen", 100*1024*1024, "The maximum length in bytes of a single line accepted by `/api/v1/import`") +var maxLineLen = flag.Int("import.maxLineLen", 100*1024*1024, "The maximum length in bytes of a single line accepted by /api/v1/import") var ( rowsInserted = metrics.NewCounter(`vm_rows_inserted_total{type="vmimport"}`) diff --git a/app/vmrestore/main.go b/app/vmrestore/main.go index 865a4f0a45..9bd399e3f7 100644 --- a/app/vmrestore/main.go +++ b/app/vmrestore/main.go @@ -18,7 +18,7 @@ var ( "VictoriaMetrics must be stopped when restoring from backup. -storageDataPath dir can be non-empty. In this case only missing data is downloaded from backup") concurrency = flag.Int("concurrency", 10, "The number of concurrent workers. Higher concurrency may reduce restore duration") maxBytesPerSecond = flag.Int("maxBytesPerSecond", 0, "The maximum download speed. There is no limit if it is set to 0") - skipBackupCompleteCheck = flag.Bool("skipBackupCompleteCheck", false, "Whether to skip checking for `backup complete` file in `-src`. This may be useful for restoring from old backups, which were created without `backup complete` file") + skipBackupCompleteCheck = flag.Bool("skipBackupCompleteCheck", false, "Whether to skip checking for 'backup complete' file in -src. This may be useful for restoring from old backups, which were created without 'backup complete' file") ) func main() { diff --git a/app/vmselect/main.go b/app/vmselect/main.go index e33e1a641b..6e33a83c75 100644 --- a/app/vmselect/main.go +++ b/app/vmselect/main.go @@ -22,8 +22,8 @@ import ( var ( deleteAuthKey = flag.String("deleteAuthKey", "", "authKey for metrics' deletion via /api/v1/admin/tsdb/delete_series") maxConcurrentRequests = flag.Int("search.maxConcurrentRequests", getDefaultMaxConcurrentRequests(), "The maximum number of concurrent search requests. "+ - "It shouldn't be high, since a single request can saturate all the CPU cores. See also `-search.maxQueueDuration`") - maxQueueDuration = flag.Duration("search.maxQueueDuration", 10*time.Second, "The maximum time the request waits for execution when `-search.maxConcurrentRequests` limit is reached") + "It shouldn't be high, since a single request can saturate all the CPU cores. See also -search.maxQueueDuration") + maxQueueDuration = flag.Duration("search.maxQueueDuration", 10*time.Second, "The maximum time the request waits for execution when -search.maxConcurrentRequests limit is reached") ) func getDefaultMaxConcurrentRequests() int { diff --git a/app/vmselect/prometheus/prometheus.go b/app/vmselect/prometheus/prometheus.go index efdc0b9c18..e425a0ea69 100644 --- a/app/vmselect/prometheus/prometheus.go +++ b/app/vmselect/prometheus/prometheus.go @@ -24,11 +24,11 @@ import ( var ( latencyOffset = flag.Duration("search.latencyOffset", time.Second*30, "The time when data points become visible in query results after the colection. "+ "Too small value can result in incomplete last points for query results") - maxExportDuration = flag.Duration("search.maxExportDuration", time.Hour*24*30, "The maximum duration for `/api/v1/export` call") + maxExportDuration = flag.Duration("search.maxExportDuration", time.Hour*24*30, "The maximum duration for /api/v1/export call") maxQueryDuration = flag.Duration("search.maxQueryDuration", time.Second*30, "The maximum duration for search query execution") maxQueryLen = flag.Int("search.maxQueryLen", 16*1024, "The maximum search query length in bytes") - maxLookback = flag.Duration("search.maxLookback", 0, "Synonim to `-search.lookback-delta` from Prometheus. "+ - "The value is dynamically detected from interval between time series datapoints if not set. It can be overridden on per-query basis via `max_lookback` arg") + maxLookback = flag.Duration("search.maxLookback", 0, "Synonim to -search.lookback-delta from Prometheus. "+ + "The value is dynamically detected from interval between time series datapoints if not set. It can be overridden on per-query basis via max_lookback arg") ) // Default step used if not set. diff --git a/lib/backup/actions/restore.go b/lib/backup/actions/restore.go index f681e876ca..29905e364f 100644 --- a/lib/backup/actions/restore.go +++ b/lib/backup/actions/restore.go @@ -62,7 +62,7 @@ func (r *Restore) Run() error { } if !ok { return fmt.Errorf("cannot find %s file in %s; this means either incomplete backup or old backup; "+ - "pass `-skipBackupCompleteCheck` command-line flag if you still need restoring from this backup", fscommon.BackupCompleteFilename, src) + "pass -skipBackupCompleteCheck command-line flag if you still need restoring from this backup", fscommon.BackupCompleteFilename, src) } } diff --git a/lib/fs/reader_at.go b/lib/fs/reader_at.go index 078d818d6d..0acaedafbb 100644 --- a/lib/fs/reader_at.go +++ b/lib/fs/reader_at.go @@ -10,7 +10,7 @@ import ( "golang.org/x/sys/unix" ) -var disableMmap = flag.Bool("fs.disableMmap", false, "Whether to use `pread` instead of `mmap` for reading data files") +var disableMmap = flag.Bool("fs.disableMmap", false, "Whether to use pread() instead of mmap() for reading data files") // MustReadAtCloser is rand-access read interface. type MustReadAtCloser interface { diff --git a/lib/httpserver/httpserver.go b/lib/httpserver/httpserver.go index 9af54e92a2..e65c6e1804 100644 --- a/lib/httpserver/httpserver.go +++ b/lib/httpserver/httpserver.go @@ -23,9 +23,9 @@ import ( ) var ( - tlsEnable = flag.Bool("tls", false, "Whether to enable TLS (aka HTTPS) for incoming requests. `-tlsCertFile` and `-tlsKeyFile` must be set if `-tls` is set") - tlsCertFile = flag.String("tlsCertFile", "", "Path to file with TLS certificate. Used only if `-tls` is set. Prefer ECDSA certs instead of RSA certs, since RSA certs are slow") - tlsKeyFile = flag.String("tlsKeyFile", "", "Path to file with TLS key. Used only if `-tls` is set") + tlsEnable = flag.Bool("tls", false, "Whether to enable TLS (aka HTTPS) for incoming requests. -tlsCertFile and -tlsKeyFile must be set if -tls is set") + tlsCertFile = flag.String("tlsCertFile", "", "Path to file with TLS certificate. Used only if -tls is set. Prefer ECDSA certs instead of RSA certs, since RSA certs are slow") + tlsKeyFile = flag.String("tlsKeyFile", "", "Path to file with TLS key. Used only if -tls is set") httpAuthUsername = flag.String("httpAuth.username", "", "Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password") httpAuthPassword = flag.String("httpAuth.password", "", "Password for HTTP Basic Auth. The authentication is disabled if -httpAuth.username is empty") diff --git a/lib/storage/dedup.go b/lib/storage/dedup.go index 04e9929a64..aa78665dbd 100644 --- a/lib/storage/dedup.go +++ b/lib/storage/dedup.go @@ -8,7 +8,7 @@ import ( var minScrapeInterval = flag.Duration("dedup.minScrapeInterval", 0, "Remove superflouos samples from time series if they are located closer to each other than this duration. "+ "This may be useful for reducing overhead when multiple identically configured Prometheus instances write data to the same VictoriaMetrics. "+ - "Deduplication is disabled if the `-dedup.minScrapeInterval` is 0") + "Deduplication is disabled if the -dedup.minScrapeInterval is 0") func getMinDelta() int64 { // Divide minScrapeInterval by 2 in order to preserve proper data points.