store: add flag to select the label to use as timeline title in web UI

Signed-off-by: Thibaut Ackermann <thibaut.ackermann@al-enterprise.com>
thanos-io · Mar 7, 2023 · 7e31886 · 7e31886
1 parent dabbeda
commit 7e31886
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ We use *breaking :warning:* to mark changes that are not backward compatible (re
 ### Added
 
 - [#6185](https://github.com/thanos-io/thanos/pull/6185) Tracing: tracing in OTLP support configuring service_name.
+- [#6192](https://github.com/thanos-io/thanos/pull/6192) Store: add flag `bucket-web-label` to select the label to use as timeline title in web UI
 
 ### Fixed
 

diff --git a/cmd/thanos/compact.go b/cmd/thanos/compact.go
@@ -781,5 +781,5 @@ func (cc *compactConfig) registerFlag(cmd extkingpin.FlagClause) {
 
 	cc.webConf.registerFlag(cmd)
 
-	cmd.Flag("bucket-web-label", "Prometheus label to use as timeline title in the bucket web UI").StringVar(&cc.label)
+	cmd.Flag("bucket-web-label", "External block label to use as group title in the bucket web UI").StringVar(&cc.label)
 }
diff --git a/cmd/thanos/store.go b/cmd/thanos/store.go
@@ -79,6 +79,7 @@ type storeConfig struct {
 	ignoreDeletionMarksDelay    commonmodel.Duration
 	disableWeb                  bool
 	webConfig                   webConfig
+	label                       string
 	postingOffsetsInMemSampling int
 	cachingBucketConfig         extflag.PathOrContent
 	reqLogConfig                *extflag.PathOrContent
@@ -183,6 +184,8 @@ func (sc *storeConfig) registerFlag(cmd extkingpin.FlagClause) {
 	cmd.Flag("web.disable-cors", "Whether to disable CORS headers to be set by Thanos. By default Thanos sets CORS headers to be allowed by all.").
 		Default("false").BoolVar(&sc.webConfig.disableCORS)
 
+	cmd.Flag("bucket-web-label", "External block label to use as group title in the bucket web UI").StringVar(&sc.label)
+
 	sc.reqLogConfig = extkingpin.RegisterRequestLoggingFlags(cmd)
 }
 
@@ -476,7 +479,7 @@ func runStore(
 
 			// Configure Request Logging for HTTP calls.
 			logMiddleware := logging.NewHTTPServerMiddleware(logger, httpLogOpts...)
-			api := blocksAPI.NewBlocksAPI(logger, conf.webConfig.disableCORS, "", flagsMap, bkt)
+			api := blocksAPI.NewBlocksAPI(logger, conf.webConfig.disableCORS, conf.label, flagsMap, bkt)
 			api.Register(r.WithPrefix("/api/v1"), tracer, logger, ins, logMiddleware)
 
 			metaFetcher.UpdateOnChange(func(blocks []metadata.Meta, err error) {

diff --git a/cmd/thanos/tools_bucket.go b/cmd/thanos/tools_bucket.go
@@ -198,7 +198,7 @@ func (tbc *bucketWebConfig) registerBucketWebFlag(cmd extkingpin.FlagClause) *bu
 
 	cmd.Flag("timeout", "Timeout to download metadata from remote storage").Default("5m").DurationVar(&tbc.timeout)
 
-	cmd.Flag("label", "Prometheus label to use as timeline title").StringVar(&tbc.label)
+	cmd.Flag("label", "External block label to use as group title").StringVar(&tbc.label)
 	return tbc
 }
 

diff --git a/docs/components/compact.md b/docs/components/compact.md
@@ -295,8 +295,8 @@ Flags:
                                 local and remote view for /global Block Viewer
                                 UI.
       --bucket-web-label=BUCKET-WEB-LABEL
-                                Prometheus label to use as timeline title in the
-                                bucket web UI
+                                External block label to use as group title in
+                                the bucket web UI
       --compact.blocks-fetch-concurrency=1
                                 Number of goroutines to use when download block
                                 during compaction.

diff --git a/docs/components/store.md b/docs/components/store.md
@@ -36,6 +36,9 @@ Flags:
                                  Number of goroutines to use when constructing
                                  index-cache.json blocks from object storage.
                                  Must be equal or greater than 1.
+      --bucket-web-label=BUCKET-WEB-LABEL
+                                 External block label to use as group title in
+                                 the bucket web UI
       --cache-index-header       Cache TSDB index-headers on disk to reduce
                                  startup time. When set to true, Thanos Store
                                  will download index headers from remote object

diff --git a/docs/components/tools.md b/docs/components/tools.md
@@ -219,7 +219,7 @@ Flags:
       --http.config=""          [EXPERIMENTAL] Path to the configuration file
                                 that can enable TLS or authentication for all
                                 HTTP endpoints.
-      --label=LABEL             Prometheus label to use as timeline title
+      --label=LABEL             External block label to use as group title
       --log.format=logfmt       Log format to use. Possible options: logfmt or
                                 json.
       --log.level=info          Log filtering level.