Skip to content

Commit e3bc18d

Browse files
committed
Promote sidecar shipper.upload-compacted flag to non hidden, non experimental state.
Signed-off-by: Bartek Plotka <[email protected]>
1 parent 5b7e33e commit e3bc18d

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

cmd/thanos/sidecar.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func registerSidecar(m map[string]setupFunc, app *kingpin.Application) {
5858

5959
objStoreConfig := regCommonObjStoreFlags(cmd, "", false)
6060

61-
uploadCompacted := cmd.Flag("shipper.upload-compacted", "[Experimental] If true sidecar will try to upload compacted blocks as well. Useful for migration purposes. Works only if compaction is disabled on Prometheus.").Default("false").Hidden().Bool()
61+
uploadCompacted := cmd.Flag("shipper.upload-compacted", "If true sidecar will try to upload compacted blocks as well. Useful for migration purposes. Works only if compaction is disabled on Prometheus. Do it once and then disable the flag when done.").Default("false").Bool()
6262

6363
minTime := thanosmodel.TimeOrDuration(cmd.Flag("min-time", "Start of time range limit to serve. Thanos sidecar will serve only metrics, which happened later than this value. Option can be a constant time in RFC3339 format or time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y.").
6464
Default("0000-01-01T00:00:00Z"))

docs/quick-tutorial.md

+5
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,11 @@ thanos sidecar \
9393

9494
* _[Example Kubernetes manifests using Prometheus operator](https://github.com/coreos/prometheus-operator/tree/master/example/thanos)_
9595

96+
### Uploading old metrics.
97+
98+
When sidecar is run with the `--shipper.upload-compacted` flag it will sync all older existing blocks from the Prometheus local storage on startup.
99+
NOTE: This assumes you never run sidecar with block uploading against this bucket. Otherwise manual steps are needed to remove overlapping blocks from the bucket.
100+
Those will be suggested by the sidecar verification process.
96101

97102
#### External Labels
98103

0 commit comments

Comments
 (0)