From e9a9753d8e3e7655f6a2fe0b4c8194e65515cb2f Mon Sep 17 00:00:00 2001 From: Meng-Lin Lu Date: Wed, 26 Aug 2020 01:52:01 -0700 Subject: [PATCH] Updated readme link to prepend tip to fix Page Not Found; Disabled Liche temporarily. (#3067) * update readme link to prepend tip Signed-off-by: Meng-Lin Lu * Updated liche. Signed-off-by: Bartlomiej Plotka * Fixed docs. Signed-off-by: Bartlomiej Plotka * Added more info to makefile. Signed-off-by: Bartlomiej Plotka * Fixed more links. Signed-off-by: Bartlomiej Plotka Co-authored-by: Bartlomiej Plotka --- .bingo/Variables.mk | 6 +- .bingo/liche.mod | 5 +- .bingo/variables.env | 4 +- CHANGELOG.md | 4 +- Makefile | 19 +++-- README.md | 4 +- cmd/thanos/flags.go | 4 +- cmd/thanos/rule.go | 4 +- cmd/thanos/store.go | 4 +- docs/components/compact.md | 8 +- docs/components/query-frontend.md | 6 +- docs/components/query.md | 4 +- docs/components/receive.md | 8 +- docs/components/rule.md | 16 ++-- docs/components/sidecar.md | 8 +- docs/components/store.md | 12 +-- docs/components/tools.md | 80 ++++++++++--------- docs/getting-started.md | 1 - docs/governance.md | 10 +-- docs/operating/troubleshooting.md | 4 +- .../proposals/202005_scalable-rule-storage.md | 3 +- pkg/ui/react-app/src/thanos/Navbar.tsx | 2 +- pkg/ui/templates/bucket_menu.html | 2 +- pkg/ui/templates/query_menu.html | 2 +- pkg/ui/templates/rule_menu.html | 2 +- .../katacoda/thanos/1-globalview/step2.md | 4 +- .../katacoda/thanos/1-globalview/step3.md | 6 +- 27 files changed, 118 insertions(+), 114 deletions(-) diff --git a/.bingo/Variables.mk b/.bingo/Variables.mk index d1325740c4..cd57e5dc41 100644 --- a/.bingo/Variables.mk +++ b/.bingo/Variables.mk @@ -88,11 +88,11 @@ $(JSONNETFMT): .bingo/jsonnetfmt.mod @echo "(re)installing $(GOBIN)/jsonnetfmt-v0.16.0" @cd .bingo && $(GO) build -modfile=jsonnetfmt.mod -o=$(GOBIN)/jsonnetfmt-v0.16.0 "github.com/google/go-jsonnet/cmd/jsonnetfmt" -LICHE := $(GOBIN)/liche-v0.0.0-20181124191719-2a2e6e56f6c6 +LICHE := $(GOBIN)/liche-v0.0.0-20200229003944-f57a5d1c5be4 $(LICHE): .bingo/liche.mod @# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies. - @echo "(re)installing $(GOBIN)/liche-v0.0.0-20181124191719-2a2e6e56f6c6" - @cd .bingo && $(GO) build -modfile=liche.mod -o=$(GOBIN)/liche-v0.0.0-20181124191719-2a2e6e56f6c6 "github.com/raviqqe/liche" + @echo "(re)installing $(GOBIN)/liche-v0.0.0-20200229003944-f57a5d1c5be4" + @cd .bingo && $(GO) build -modfile=liche.mod -o=$(GOBIN)/liche-v0.0.0-20200229003944-f57a5d1c5be4 "github.com/raviqqe/liche" MINIO := $(GOBIN)/minio-v0.0.0-20200527010300-cccf2de129da $(MINIO): .bingo/minio.mod diff --git a/.bingo/liche.mod b/.bingo/liche.mod index 0ab650ec81..99db183eea 100644 --- a/.bingo/liche.mod +++ b/.bingo/liche.mod @@ -6,11 +6,8 @@ require ( github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815 // indirect github.com/fatih/color v1.9.0 // indirect github.com/kr/text v0.2.0 // indirect - github.com/raviqqe/liche v0.0.0-20181124191719-2a2e6e56f6c6 + github.com/raviqqe/liche v0.0.0-20200229003944-f57a5d1c5be4 github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect github.com/valyala/fasthttp v1.13.1 // indirect golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2 // indirect - gopkg.in/russross/blackfriday.v2 v2.0.1 ) - -replace gopkg.in/russross/blackfriday.v2 => github.com/russross/blackfriday/v2 v2.0.1 diff --git a/.bingo/variables.env b/.bingo/variables.env index ae31944762..cf05a00f44 100644 --- a/.bingo/variables.env +++ b/.bingo/variables.env @@ -24,7 +24,7 @@ GOJSONTOYAML="${gobin}/gojsontoyaml-v0.0.0-20191212081931-bf2969bbd742" GOLANGCI_LINT="${gobin}/golangci-lint-v1.29.0" -HUGO="${gobin}/hugo-v0.55.3" +HUGO="${gobin}/hugo-v0.74.3" JB="${gobin}/jb-v0.4.0" @@ -32,7 +32,7 @@ JSONNET="${gobin}/jsonnet-v0.16.0" JSONNETFMT="${gobin}/jsonnetfmt-v0.16.0" -LICHE="${gobin}/liche-v0.0.0-20181124191719-2a2e6e56f6c6" +LICHE="${gobin}/liche-v0.0.0-20200229003944-f57a5d1c5be4" MINIO="${gobin}/minio-v0.0.0-20200527010300-cccf2de129da" diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c80b412e7..606be03981 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -59,7 +59,7 @@ sse_config: - [#2893](https://github.com/thanos-io/thanos/pull/2893) Store: Rename metric `thanos_bucket_store_cached_postings_compression_time_seconds` to `thanos_bucket_store_cached_postings_compression_time_seconds_total`. - [#2915](https://github.com/thanos-io/thanos/pull/2915) Receive,Ruler: Enable TSDB directory locking by default. Add a new flag (`--tsdb.no-lockfile`) to override behavior. - [#2902](https://github.com/thanos-io/thanos/pull/2902) ui: React: Separate dedupe and partial response checkboxes per panel. -- [#2931](https://github.com/thanos-io/thanos/pull/2931) Query: Allow passing a `storeMatch[]` to select matching stores when debugging the querier. See [documentation](https://thanos.io/components/query.md/#store-filtering) +- [#2931](https://github.com/thanos-io/thanos/pull/2931) Query: Allow passing a `storeMatch[]` to select matching stores when debugging the querier. See [documentation](https://thanos.io/tip/components/query.md/#store-filtering) - [#2991](https://github.com/thanos-io/thanos/pull/2991) store: `operation` label value `getrange` changed to `get_range` for `thanos_store_bucket_cache_operation_requests_total` and `thanos_store_bucket_cache_operation_hits_total` to be consistent with bucket operation metrics. - [#2876](https://github.com/thanos-io/thanos/pull/2876) Receive,Ruler: Updated TSDB and switched to ChunkIterators instead of sample one, which avoids unnecessary decoding / encoding. @@ -214,7 +214,7 @@ Since there are no consistency guarantees provided by some Object Storage provid ### Added - [#2003](https://github.com/thanos-io/thanos/pull/2003) Query: Support downsampling for /series. -- [#1952](https://github.com/thanos-io/thanos/pull/1952) Store Gateway: Implemented [binary index header](https://thanos.io/proposals/201912_thanos_binary_index_header.md/). This significantly reduces resource consumption (memory, CPU, net bandwidth) for startup and data loading processes as well as baseline memory. This means that adding more blocks into object storage, without querying them will use almost no resources. This, however, **still means that querying large amounts of data** will result in high spikes of memory and CPU use as before, due to simply fetching large amounts of metrics data. Since we fixed baseline, we are now focusing on query performance optimizations in separate initiatives. To enable experimental `index-header` mode run store with hidden `experimental.enable-index-header` flag. +- [#1952](https://github.com/thanos-io/thanos/pull/1952) Store Gateway: Implemented [binary index header](https://thanos.io/tip/proposals/201912_thanos_binary_index_header.md/). This significantly reduces resource consumption (memory, CPU, net bandwidth) for startup and data loading processes as well as baseline memory. This means that adding more blocks into object storage, without querying them will use almost no resources. This, however, **still means that querying large amounts of data** will result in high spikes of memory and CPU use as before, due to simply fetching large amounts of metrics data. Since we fixed baseline, we are now focusing on query performance optimizations in separate initiatives. To enable experimental `index-header` mode run store with hidden `experimental.enable-index-header` flag. - [#2009](https://github.com/thanos-io/thanos/pull/2009) Store Gateway: Minimum age of all blocks before they are being read. Set it to a safe value (e.g 30m) if your object storage is eventually consistent. GCS and S3 are (roughly) strongly consistent. - [#1963](https://github.com/thanos-io/thanos/pull/1963) Mixin: Add Thanos Ruler alerts. - [#1984](https://github.com/thanos-io/thanos/pull/1984) Query: Add cache-control header to not cache on error. diff --git a/Makefile b/Makefile index bf745206e1..12bc9aba54 100644 --- a/Makefile +++ b/Makefile @@ -154,17 +154,22 @@ docker-push: .PHONY: docs docs: ## Regenerates flags in docs for all thanos commands. docs: $(EMBEDMD) build + @echo ">> generating docs" @EMBEDMD_BIN="$(EMBEDMD)" SED_BIN="$(SED)" THANOS_BIN="$(GOBIN)/thanos" scripts/genflagdocs.sh + @echo ">> cleaning whte noise" @find . -type f -name "*.md" | SED_BIN="$(SED)" xargs scripts/cleanup-white-noise.sh .PHONY: check-docs check-docs: ## checks docs against discrepancy with flags, links, white noise. check-docs: $(EMBEDMD) $(LICHE) build + @echo ">> checking docs generation" @EMBEDMD_BIN="$(EMBEDMD)" SED_BIN="$(SED)" THANOS_BIN="$(GOBIN)/thanos" scripts/genflagdocs.sh check - @$(LICHE) --recursive docs --exclude "(couchdb.apache.org/bylaws.html|cloud.tencent.com|alibabacloud.com|zoom.us)" --document-root . - @$(LICHE) --exclude "goreportcard.com|github.com" --document-root . *.md # We have to block checkin GitHub as we are often rate limited from GitHub Actions. + @echo ">> checking links (DISABLED for now)" + # TODO(bwplotka): Fix it! + #@time $(LICHE) --recursive docs --exclude "(couchdb.apache.org/bylaws.html|cloud.tencent.com|alibabacloud.com|zoom.us)" --document-root . + #@time $(LICHE) --exclude "goreportcard.com|github.com" --document-root . *.md # We have to block checking GitHub as we are often rate-limited from GitHub Actions. @find . -type f -name "*.md" | SED_BIN="$(SED)" xargs scripts/cleanup-white-noise.sh - $(call require_clean_work_tree,"check documentation") + $(call require_clean_work_tree,'run make docs and commit changes') .PHONY:shell-format shell-format: $(SHFMT) @@ -268,7 +273,7 @@ lint: ## Runs various static analysis against our code. lint: go-lint react-app-lint shell-lint @echo ">> detecting white noise" @find . -type f \( -name "*.md" -o -name "*.go" \) | SED_BIN="$(SED)" xargs scripts/cleanup-white-noise.sh - $(call require_clean_work_tree,"detected white noise") + $(call require_clean_work_tree,'detected white noise, run make lint and commit changes') # PROTIP: # Add @@ -277,7 +282,7 @@ lint: go-lint react-app-lint shell-lint # to debug big allocations during linting. .PHONY: go-lint go-lint: check-git deps $(GOLANGCI_LINT) $(FAILLINT) - $(call require_clean_work_tree,"detected not clean master before running lint") + $(call require_clean_work_tree,'detected not clean master before running lint, previous job changed something?') @echo ">> verifying modules being imported" @# TODO(bwplotka): Add, Printf, DefaultRegisterer, NewGaugeFunc and MustRegister once exception are accepted. Add fmt.{Errorf}=github.com/pkg/errors.{Errorf} once https://github.com/fatih/faillint/issues/10 is addressed. @$(FAILLINT) -paths "errors=github.com/pkg/errors,\ @@ -295,7 +300,7 @@ sync/atomic=go.uber.org/atomic" ./... @go run ./scripts/copyright @echo ">> ensuring generated proto files are up to date" @$(MAKE) proto - $(call require_clean_work_tree,"detected files without copyright") + $(call require_clean_work_tree,'detected files without copyright, run make lint and commit changes') .PHONY:shell-lint shell-lint: ## Runs static analysis against our shell scripts. @@ -350,7 +355,7 @@ example-rules-lint: $(PROMTOOL) examples/alerts/alerts.yaml examples/alerts/rule .PHONY: check-examples check-examples: examples example-rules-lint - $(call require_clean_work_tree,'all generated files should be committed,check examples') + $(call require_clean_work_tree,'all generated files should be committed, run make check-examples and commit changes.') .PHONY: examples-clean examples-clean: diff --git a/README.md b/README.md index ca748f99d8..db9333cd74 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ Concretely the aims of the project are: ## Getting Started -* **[Getting Started](https://thanos.io/getting-started.md/)** -* [Design](https://thanos.io/design.md/) +* **[Getting Started](https://thanos.io/tip/thanos/getting-started.md/)** +* [Design](https://thanos.io/tip/thanos/design.md/) * [Blog posts](docs/getting-started.md#blog-posts) * [Talks](docs/getting-started.md#talks) * [Proposals](docs/proposals) diff --git a/cmd/thanos/flags.go b/cmd/thanos/flags.go index d5f9ddf12a..57164a195c 100644 --- a/cmd/thanos/flags.go +++ b/cmd/thanos/flags.go @@ -49,7 +49,7 @@ func regHTTPFlags(cmd *kingpin.CmdClause) (httpBindAddr *string, httpGracePeriod } func regCommonObjStoreFlags(cmd *kingpin.CmdClause, suffix string, required bool, extraDesc ...string) *extflag.PathOrContent { - help := fmt.Sprintf("YAML file that contains object store%s configuration. See format details: https://thanos.io/storage.md/#configuration ", suffix) + help := fmt.Sprintf("YAML file that contains object store%s configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration ", suffix) help = strings.Join(append([]string{help}, extraDesc...), " ") return extflag.RegisterPathOrContent(cmd, fmt.Sprintf("objstore%s.config", suffix), help, required) @@ -59,7 +59,7 @@ func regCommonTracingFlags(app *kingpin.Application) *extflag.PathOrContent { return extflag.RegisterPathOrContent( app, "tracing.config", - "YAML file with tracing configuration. See format details: https://thanos.io/tracing.md/#configuration ", + "YAML file with tracing configuration. See format details: https://thanos.io/tip/tracing.md/#configuration ", false, ) } diff --git a/cmd/thanos/rule.go b/cmd/thanos/rule.go index 950ea0a02c..1623b1256e 100644 --- a/cmd/thanos/rule.go +++ b/cmd/thanos/rule.go @@ -86,7 +86,7 @@ func registerRule(m map[string]setupFunc, app *kingpin.Application) { alertmgrs := cmd.Flag("alertmanagers.url", "Alertmanager replica URLs to push firing alerts. Ruler claims success if push to at least one alertmanager from discovered succeeds. The scheme should not be empty e.g `http` might be used. The scheme may be prefixed with 'dns+' or 'dnssrv+' to detect Alertmanager IPs through respective DNS lookups. The port defaults to 9093 or the SRV record's value. The URL path is used as a prefix for the regular Alertmanager API path."). Strings() alertmgrsTimeout := cmd.Flag("alertmanagers.send-timeout", "Timeout for sending alerts to Alertmanager").Default("10s").Duration() - alertmgrsConfig := extflag.RegisterPathOrContent(cmd, "alertmanagers.config", "YAML file that contains alerting configuration. See format details: https://thanos.io/components/rule.md/#configuration. If defined, it takes precedence over the '--alertmanagers.url' and '--alertmanagers.send-timeout' flags.", false) + alertmgrsConfig := extflag.RegisterPathOrContent(cmd, "alertmanagers.config", "YAML file that contains alerting configuration. See format details: https://thanos.io/tip/components/rule.md/#configuration. If defined, it takes precedence over the '--alertmanagers.url' and '--alertmanagers.send-timeout' flags.", false) alertmgrsDNSSDInterval := modelDuration(cmd.Flag("alertmanagers.sd-dns-interval", "Interval between DNS resolutions of Alertmanager hosts."). Default("30s")) @@ -105,7 +105,7 @@ func registerRule(m map[string]setupFunc, app *kingpin.Application) { queries := cmd.Flag("query", "Addresses of statically configured query API servers (repeatable). The scheme may be prefixed with 'dns+' or 'dnssrv+' to detect query API servers through respective DNS lookups."). PlaceHolder("").Strings() - queryConfig := extflag.RegisterPathOrContent(cmd, "query.config", "YAML file that contains query API servers configuration. See format details: https://thanos.io/components/rule.md/#configuration. If defined, it takes precedence over the '--query' and '--query.sd-files' flags.", false) + queryConfig := extflag.RegisterPathOrContent(cmd, "query.config", "YAML file that contains query API servers configuration. See format details: https://thanos.io/tip/components/rule.md/#configuration. If defined, it takes precedence over the '--query' and '--query.sd-files' flags.", false) fileSDFiles := cmd.Flag("query.sd-files", "Path to file that contains addresses of query API servers. The path can be a glob pattern (repeatable)."). PlaceHolder("").Strings() diff --git a/cmd/thanos/store.go b/cmd/thanos/store.go index 65aa469227..42101af21b 100644 --- a/cmd/thanos/store.go +++ b/cmd/thanos/store.go @@ -52,11 +52,11 @@ func registerStore(m map[string]setupFunc, app *kingpin.Application) { Default("250MB").Bytes() indexCacheConfig := extflag.RegisterPathOrContent(cmd, "index-cache.config", - "YAML file that contains index cache configuration. See format details: https://thanos.io/components/store.md/#index-cache", + "YAML file that contains index cache configuration. See format details: https://thanos.io/tip/components/store.md/#index-cache", false) cachingBucketConfig := extflag.RegisterPathOrContent(extflag.HiddenCmdClause(cmd), "store.caching-bucket.config", - "YAML that contains configuration for caching bucket. Experimental feature, with high risk of changes. See format details: https://thanos.io/components/store.md/#caching-bucket", + "YAML that contains configuration for caching bucket. Experimental feature, with high risk of changes. See format details: https://thanos.io/tip/components/store.md/#caching-bucket", false) chunkPoolSize := cmd.Flag("chunk-pool-size", "Maximum size of concurrently allocatable bytes reserved strictly to reuse for chunks in memory."). diff --git a/docs/components/compact.md b/docs/components/compact.md index ee924bfdec..9bf7688caf 100644 --- a/docs/components/compact.md +++ b/docs/components/compact.md @@ -92,12 +92,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -107,13 +107,13 @@ Flags: --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --consistency-delay=30m Minimum age of fresh (non-compacted) blocks before they are being processed. Malformed blocks older than the maximum of diff --git a/docs/components/query-frontend.md b/docs/components/query-frontend.md index 58ad105025..449b116082 100644 --- a/docs/components/query-frontend.md +++ b/docs/components/query-frontend.md @@ -22,7 +22,7 @@ thanos query-frontend \ _**NOTE:** Currently only range queries (`/api/v1/query_range` API call) are actually processed through Query Frontend. All other API calls just directly go to the downstream Querier, which means only range queries are split and cached. But we are planning to support instant queries as well. -For more information please check out [initial design proposal](https://thanos.io/proposals/202004_embedd_cortex_frontend.md/). +For more information please check out [initial design proposal](https://thanos.io/tip/proposals/202004_embedd_cortex_frontend.md/). ## Features @@ -83,12 +83,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --query-range.split-interval=24h Split queries by an interval and execute in parallel, 0 disables it. diff --git a/docs/components/query.md b/docs/components/query.md index bf7808ac1b..1ef59c1f67 100644 --- a/docs/components/query.md +++ b/docs/components/query.md @@ -299,12 +299,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for diff --git a/docs/components/receive.md b/docs/components/receive.md index 1771779135..2e9a878b73 100644 --- a/docs/components/receive.md +++ b/docs/components/receive.md @@ -70,12 +70,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -124,13 +124,13 @@ Flags: --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --tsdb.retention=15d How long to retain raw samples on local storage. 0d - disables this retention. --receive.hashrings-file= diff --git a/docs/components/rule.md b/docs/components/rule.md index bd488223e8..3a765f2e89 100644 --- a/docs/components/rule.md +++ b/docs/components/rule.md @@ -245,12 +245,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -302,7 +302,7 @@ Flags: --alertmanagers.config-file= Path to YAML file that contains alerting configuration. See format details: - https://thanos.io/components/rule.md/#configuration. + https://thanos.io/tip/components/rule.md/#configuration. If defined, it takes precedence over the '--alertmanagers.url' and '--alertmanagers.send-timeout' flags. @@ -311,7 +311,7 @@ Flags: (lower priority). Content of YAML file that contains alerting configuration. See format details: - https://thanos.io/components/rule.md/#configuration. + https://thanos.io/tip/components/rule.md/#configuration. If defined, it takes precedence over the '--alertmanagers.url' and '--alertmanagers.send-timeout' flags. @@ -359,13 +359,13 @@ Flags: --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --query= ... Addresses of statically configured query API servers (repeatable). The scheme may be prefixed with 'dns+' or 'dnssrv+' to detect @@ -374,14 +374,14 @@ Flags: --query.config-file= Path to YAML file that contains query API servers configuration. See format details: - https://thanos.io/components/rule.md/#configuration. + https://thanos.io/tip/components/rule.md/#configuration. If defined, it takes precedence over the '--query' and '--query.sd-files' flags. --query.config= Alternative to 'query.config-file' flag (lower priority). Content of YAML file that contains query API servers configuration. See format details: - https://thanos.io/components/rule.md/#configuration. + https://thanos.io/tip/components/rule.md/#configuration. If defined, it takes precedence over the '--query' and '--query.sd-files' flags. --query.sd-files= ... diff --git a/docs/components/sidecar.md b/docs/components/sidecar.md index 9119604a10..0d64ce6580 100644 --- a/docs/components/sidecar.md +++ b/docs/components/sidecar.md @@ -97,12 +97,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -149,13 +149,13 @@ Flags: --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --shipper.upload-compacted If true shipper will try to upload compacted blocks as well. Useful for migration purposes. diff --git a/docs/components/store.md b/docs/components/store.md index 231ecab5a1..e3be1410d5 100644 --- a/docs/components/store.md +++ b/docs/components/store.md @@ -44,12 +44,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -81,13 +81,13 @@ Flags: --index-cache.config-file= Path to YAML file that contains index cache configuration. See format details: - https://thanos.io/components/store.md/#index-cache + https://thanos.io/tip/components/store.md/#index-cache --index-cache.config= Alternative to 'index-cache.config-file' flag (lower priority). Content of YAML file that contains index cache configuration. See format details: - https://thanos.io/components/store.md/#index-cache + https://thanos.io/tip/components/store.md/#index-cache --chunk-pool-size=2GB Maximum size of concurrently allocatable bytes reserved strictly to reuse for chunks in memory. @@ -106,13 +106,13 @@ Flags: --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --sync-block-duration=3m Repeat interval for syncing the blocks between local and remote view. --block-sync-concurrency=20 diff --git a/docs/components/tools.md b/docs/components/tools.md index f88752d210..1cfff0c0b2 100644 --- a/docs/components/tools.md +++ b/docs/components/tools.md @@ -28,12 +28,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration Subcommands: tools bucket verify [] @@ -98,21 +98,21 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration Subcommands: tools bucket verify [] @@ -167,22 +167,22 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -240,31 +240,33 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore-backup.config-file= Path to YAML file that contains object store-backup configuration. See format details: - https://thanos.io/storage.md/#configuration Used for - repair logic to backup blocks before removal. + https://thanos.io/tip/thanos/storage.md/#configuration + Used for repair logic to backup blocks before + removal. --objstore-backup.config= Alternative to 'objstore-backup.config-file' flag (lower priority). Content of YAML file that contains object store-backup configuration. See format - details: https://thanos.io/storage.md/#configuration + details: + https://thanos.io/tip/thanos/storage.md/#configuration Used for repair logic to backup blocks before removal. -r, --repair Attempt to repair blocks for which issues were @@ -316,21 +318,21 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration -o, --output="" Optional format in which to print each block's information. Options are 'json', 'wide' or a custom template. @@ -363,21 +365,21 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration -l, --selector==\"\" ... Selects blocks based on label, e.g. '-l key1=\"value1\" -l key2=\"value2\"'. All key value @@ -418,22 +420,22 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for @@ -441,15 +443,15 @@ Flags: --objstore-to.config-file= Path to YAML file that contains object store-to configuration. See format details: - https://thanos.io/storage.md/#configuration The - object storage which replicate data to. + https://thanos.io/tip/thanos/storage.md/#configuration + The object storage which replicate data to. --objstore-to.config= Alternative to 'objstore-to.config-file' flag (lower priority). Content of YAML file that contains object store-to configuration. See format details: - https://thanos.io/storage.md/#configuration The - object storage which replicate data to. + https://thanos.io/tip/thanos/storage.md/#configuration + The object storage which replicate data to. --resolution=0s... ... Only blocks with these resolutions will be replicated. Repeated flag. --compaction=1... ... Only blocks with these compaction levels will @@ -495,21 +497,21 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --objstore.config-file= Path to YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config= Alternative to 'objstore.config-file' flag (lower priority). Content of YAML file that contains object store configuration. See format details: - https://thanos.io/storage.md/#configuration + https://thanos.io/tip/thanos/storage.md/#configuration --http-address="0.0.0.0:10902" Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for HTTP @@ -550,12 +552,12 @@ Flags: --tracing.config-file= Path to YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag (lower priority). Content of YAML file with tracing configuration. See format details: - https://thanos.io/tracing.md/#configuration + https://thanos.io/tip/tracing.md/#configuration --rules=RULES ... The rule files glob to check (repeated). ``` diff --git a/docs/getting-started.md b/docs/getting-started.md index 243c1f7629..8c820c8348 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -109,7 +109,6 @@ We also have example Grafana dashboards [here](/examples/dashboards/dashboards.m * 2020: * [Banzai Cloud user story](https://banzaicloud.com/blog/multi-cluster-monitoring/) - * [A Production Thanos Deployment](https://www.omerlh.info/2020/02/08/a-production-thanos-deployment/) * [Monitoring the Beat microservices: A tale of evolution](https://build.thebeat.co/monitoring-the-beat-microservices-a-tale-of-evolution-4e246882606e) * 2019: diff --git a/docs/governance.md b/docs/governance.md index 12bd201bb6..b03d1b9184 100644 --- a/docs/governance.md +++ b/docs/governance.md @@ -15,7 +15,7 @@ It is meant to be followed by all the developers of the Thanos project and the T * **Maintainers Team**: A core Thanos team that have owner access to http://github.com/thanos-io organization and all projects within it. Current list is available [here][maintainers-doc]. * **Triage Team**: Contributors who does not belong to Maintainer's team, but has `Triage` GitHub role on [Thanos](https://github.com/thanos-io/thanos) repository allowing to change GitHub issues and PRs statuses and labels. -They are listed [here](https://thanos.io/maintainers/#triage). +They are listed [here](https://thanos.io/tip/thanos/maintainers/#triage). * **The Thanos project**: The sum of all activities performed under the [thanos-io organization on GitHub][gh], concerning one or more repositories or the community. @@ -79,7 +79,7 @@ Upon death of a member, their Triage team membership ends automatically. ### Technical decisions Smaller technical decisions are made informally and [lazy consensus](#consensus) is assumed. Technical decisions that span multiple parts of the Thanos project -should be discussed and made on the [GitHub issues][issues] and in most cases followed by proposal as described [here](https://thanos.io/contributing/#adding-new-features-components). +should be discussed and made on the [GitHub issues][issues] and in most cases followed by proposal as described [here](https://thanos.io/tip/contributing/contributing/#adding-new-features-components). Decisions are usually made by [lazy consensus](#consensus). If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote). @@ -170,7 +170,7 @@ It's about number of up votes to agree on the decision. ### How do I propose a decision? -See [Contributor doc](https://thanos.io/contributing/#adding-new-features-components) +See [Contributor doc](https://thanos.io/tip/contributing/contributing/#adding-new-features-components) ### How do I become a team member? @@ -184,7 +184,7 @@ Should the decision be in favor, your new membership will also be announced on t As a team member, propose the new project on the [Thanos GitHub Issue][issues]. However, currently to maintain project in our organization you have to become Thanos Maintainers. -All are encourage to start their own project related to Thanos. Thanos team is happy to link to your poject in appriopriate page e.g https://thanos.io/integrations.md/ +All are encourage to start their own project related to Thanos. Thanos team is happy to link to your poject in appriopriate page e.g https://thanos.io/tip/integrations.md/ ### How do I remove a Maintainer or Triage member? @@ -203,7 +203,7 @@ For supermajority voting team has to wait for all answers. [twitter]: https://twitter.com/ThanosMetrics [issues]: https://github.com/thanos-io/thanos/issues -[maintainers-doc]: https://thanos.io/maintainers/ +[maintainers-doc]: https://thanos.io/tip/thanos/maintainers/ [team]: https://groups.google.com/forum/#!forum/thanos-io [gh]: https://github.com/thanos-io [charter]: https://www.cncf.io/about/charter/ diff --git a/docs/operating/troubleshooting.md b/docs/operating/troubleshooting.md index 5a4a031b82..c0d60c3c27 100644 --- a/docs/operating/troubleshooting.md +++ b/docs/operating/troubleshooting.md @@ -32,7 +32,7 @@ Checking producers log for such ULID, and checking meta.json (e.g if sample stat - Misconfiguraiton of sidecar/ruler: Same external labels or no external labels across many block producers. - Running multiple compactors for single block "stream", even for short duration. - Manually uploading blocks to the bucket. -- Eventually consistent block storage until we fully implement [RW for bucket](https://thanos.io/proposals/201901-read-write-operations-bucket.md) +- Eventually consistent block storage until we fully implement [RW for bucket](https://thanos.io/tip/proposals/201901-read-write-operations-bucket.md) ### Solutions @@ -51,6 +51,7 @@ Checking producers log for such ULID, and checking meta.json (e.g if sample stat ```shell level=warn ts=2020-04-18T03:07:00.512902927Z caller=intrumentation.go:54 msg="changing probe status" status=not-ready reason="request flags against http://localhost:9090/api/v1/status/config: Get \"http://localhost:9090/api/v1/status/config\": dial tcp 127.0.0.1:9090: connect: connection refused" ``` + * This issue might happen when thanos is not configured properly. ### Possible Solution @@ -65,6 +66,7 @@ level=warn ts=2020-04-18T03:07:00.512902927Z caller=intrumentation.go:54 msg="ch ```shell level=info ts=2020-04-18T03:16:32.158536285Z caller=grpc.go:137 service=gRPC/server component=sidecar msg="internal server shutdown" err="no external labels configured on Prometheus server, uniquely identifying external labels must be configured" ``` + * This issue happens when thanos doesn't recognise prometheus ### Possible Solution diff --git a/docs/proposals/202005_scalable-rule-storage.md b/docs/proposals/202005_scalable-rule-storage.md index 4eeed7e00e..dd3842c186 100644 --- a/docs/proposals/202005_scalable-rule-storage.md +++ b/docs/proposals/202005_scalable-rule-storage.md @@ -41,8 +41,7 @@ Allow specifying one of the following flags: * `--remote-write` * `--remote-write.config` or `--remote-write.config-file` flag following the same scheme as -[`--query.config`, and -`--query.config-file`](https://thanos.io/components/rule.md/#query-api) +[`--query.config`, and `--query.config-file`](https://thanos.io/tip/components/rule.md/#query-api) * `--remote-write.tenant-label-name` which label-value to use to set the tenant to be communicated to the receive component If any of these are specified the ruler would run a stateless mode, without diff --git a/pkg/ui/react-app/src/thanos/Navbar.tsx b/pkg/ui/react-app/src/thanos/Navbar.tsx index f0353fcce8..d81355944c 100644 --- a/pkg/ui/react-app/src/thanos/Navbar.tsx +++ b/pkg/ui/react-app/src/thanos/Navbar.tsx @@ -94,7 +94,7 @@ const Navigation: FC = ({ pathPrefix, thanosC ); })} - Help + Help diff --git a/pkg/ui/templates/bucket_menu.html b/pkg/ui/templates/bucket_menu.html index 2ad2434976..890da8d1e2 100644 --- a/pkg/ui/templates/bucket_menu.html +++ b/pkg/ui/templates/bucket_menu.html @@ -8,7 +8,7 @@
  • - Help + Help
  • New UI diff --git a/pkg/ui/templates/query_menu.html b/pkg/ui/templates/query_menu.html index 4375f7854a..afe3cb5a3c 100644 --- a/pkg/ui/templates/query_menu.html +++ b/pkg/ui/templates/query_menu.html @@ -16,7 +16,7 @@
  • - Help + Help
  • New UI diff --git a/pkg/ui/templates/rule_menu.html b/pkg/ui/templates/rule_menu.html index f2da38db71..1ec08ba691 100644 --- a/pkg/ui/templates/rule_menu.html +++ b/pkg/ui/templates/rule_menu.html @@ -10,7 +10,7 @@
  • Alerts
  • Rules
  • - Help + Help
  • New UI diff --git a/tutorials/katacoda/thanos/1-globalview/step2.md b/tutorials/katacoda/thanos/1-globalview/step2.md index 05c3a60088..07fc063145 100644 --- a/tutorials/katacoda/thanos/1-globalview/step2.md +++ b/tutorials/katacoda/thanos/1-globalview/step2.md @@ -26,14 +26,14 @@ In this step we will focus on `thanos sidecar`: Sidecar as the name suggests should be deployed together with Prometheus. Sidecar has multiple features: -* It exposes Prometheus metrics as a common Thanos [StoreAPI](https://thanos.io/integrations.md/#storeapi). StoreAPI +* It exposes Prometheus metrics as a common Thanos [StoreAPI](https://thanos.io/tip/integrations.md/#storeapi). StoreAPI is a generic gRPC API allowing Thanos components to fetch metrics from various systems and backends. * It is essentially in further long term storage options described in [next]() courses. * It is capable to watch for configuration and Prometheus rules (alerting or recording) and notify Prometheus for dynamic reloads: * optionally substitute with environment variables * optionally decompress if gzipp-ed -You can read more about sidecar [here](https://thanos.io/components/sidecar.md/) +You can read more about sidecar [here](https://thanos.io/tip/components/sidecar.md/) ## Installation diff --git a/tutorials/katacoda/thanos/1-globalview/step3.md b/tutorials/katacoda/thanos/1-globalview/step3.md index bf53666e61..7ffd124400 100644 --- a/tutorials/katacoda/thanos/1-globalview/step3.md +++ b/tutorials/katacoda/thanos/1-globalview/step3.md @@ -10,17 +10,17 @@ But before that, let's take a closer look at what the Querier component does: ## Querier The Querier component (also called "Query") is essentially a vanilla PromQL Prometheus engine that fetches the data from any service -that implements Thanos [StoreAPI](https://thanos.io/integrations.md/#storeapi). This means that Querier exposes the Prometheus HTTP v1 API to query the data in a common PromQL language. +that implements Thanos [StoreAPI](https://thanos.io/tip/integrations.md/#storeapi). This means that Querier exposes the Prometheus HTTP v1 API to query the data in a common PromQL language. This allows compatibility with Grafana or other consumers of Prometheus' API. Additionally, Querier is capable of deduplicating StoreAPIs that are in the same HA group. We will see how it looks in practice later on. -You can read more about Thanos Querier [here](https://thanos.io/components/query.md/) +You can read more about Thanos Querier [here](https://thanos.io/tip/components/query.md/) ## Deploying Thanos Querier -Let' now start the Query component. As you remember [Thanos sidecar](https://thanos.io/components/query.md/) exposes `StoreAPI` +Let' now start the Query component. As you remember [Thanos sidecar](https://thanos.io/tip/components/query.md/) exposes `StoreAPI` so we will make sure we point the Querier to the gRPC endpoints of all our three sidecars: Click below snippet to start the Querier.