diff --git a/docs/components/compact.md b/docs/components/compact.md index bf81a7f70c4..543557c7009 100644 --- a/docs/components/compact.md +++ b/docs/components/compact.md @@ -314,47 +314,47 @@ Flags: Setting it to "0s" disables it. Now compaction, downsampling and retention progress are supported. - --consistency-delay=30m Minimum age of fresh (non-compacted) - blocks before they are being processed. - Malformed blocks older than the maximum of + --consistency-delay=30m Minimum age of fresh (non-compacted) blocks + before they are being processed. Malformed + blocks older than the maximum of consistency-delay and 48h0m0s will be removed. --data-dir="./data" Data directory in which to cache blocks and process compactions. --deduplication.func= Experimental. Deduplication algorithm for merging overlapping blocks. Possible values are: - "", "penalty". If no value is specified, - the default compact deduplication merger - is used, which performs 1:1 deduplication - for samples. When set to penalty, penalty - based deduplication algorithm will be used. - At least one replica label has to be set via + "", "penalty". If no value is specified, the + default compact deduplication merger is used, + which performs 1:1 deduplication for samples. + When set to penalty, penalty based deduplication + algorithm will be used. At least one replica + label has to be set via --deduplication.replica-label flag. --deduplication.replica-label=DEDUPLICATION.REPLICA-LABEL ... Label to treat as a replica indicator of blocks that can be deduplicated (repeated flag). This will merge multiple replica blocks into one. - This process is irreversible.Experimental. - When one or more labels are set, compactor - will ignore the given labels so that vertical - compaction can merge the blocks.Please note - that by default this uses a NAIVE algorithm - for merging which works well for deduplication - of blocks with **precisely the same samples** - like produced by Receiver replication.If you - need a different deduplication algorithm (e.g - one that works well with Prometheus replicas), - please set it via --deduplication.func. + This process is irreversible.Experimental. When + one or more labels are set, compactor will + ignore the given labels so that vertical + compaction can merge the blocks.Please note that + by default this uses a NAIVE algorithm for + merging which works well for deduplication of + blocks with **precisely the same samples** like + produced by Receiver replication.If you need a + different deduplication algorithm (e.g one that + works well with Prometheus replicas), please set + it via --deduplication.func. --delete-delay=48h Time before a block marked for deletion is deleted from bucket. If delete-delay is non zero, blocks will be marked for deletion and compactor component will delete blocks marked - for deletion from the bucket. If delete-delay - is 0, blocks will be deleted straight away. - Note that deleting blocks immediately can cause - query failures, if store gateway still has the - block loaded, or compactor is ignoring the - deletion because it's compacting the block at - the same time. + for deletion from the bucket. If delete-delay is + 0, blocks will be deleted straight away. Note + that deleting blocks immediately can cause query + failures, if store gateway still has the block + loaded, or compactor is ignoring the deletion + because it's compacting the block at the same + time. --downsample.concurrency=1 Number of goroutines to use when downsampling blocks. @@ -364,11 +364,11 @@ Flags: e.g it is not possible to render all samples for a human eye anyway --hash-func= Specify which hash function to use when - calculating the hashes of produced files. - If no function has been specified, it does not - happen. This permits avoiding downloading some - files twice albeit at some performance cost. - Possible values are: "", "SHA256". + calculating the hashes of produced files. If no + function has been specified, it does not happen. + This permits avoiding downloading some files + twice albeit at some performance cost. Possible + values are: "", "SHA256". -h, --help Show context-sensitive help (also try --help-long and --help-man). --http-address="0.0.0.0:10902" @@ -382,29 +382,29 @@ Flags: json. --log.level=info Log filtering level. --max-time=9999-12-31T23:59:59Z - End of time range limit to compact. - Thanos Compactor will compact only blocks, - which happened earlier than this value. Option - can be a constant time in RFC3339 format or time + End of time range limit to compact. Thanos + Compactor will compact only blocks, which + happened earlier 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. --min-time=0000-01-01T00:00:00Z - Start of time range limit to compact. - Thanos Compactor will compact only blocks, which + Start of time range limit to compact. Thanos + Compactor will compact only blocks, 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. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --retention.resolution-1h=0d How long to retain samples of resolution 2 (1 @@ -420,26 +420,26 @@ Flags: resolution forever --selector.relabel-config= Alternative to 'selector.relabel-config-file' - flag (mutually exclusive). Content of - YAML file that contains relabeling - configuration that allows selecting - blocks. It follows native Prometheus - relabel-config syntax. See format details: + flag (mutually exclusive). Content of YAML file + that contains relabeling configuration that + allows selecting blocks. It follows native + Prometheus relabel-config syntax. See format + details: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config --selector.relabel-config-file= Path to YAML file that contains relabeling - configuration that allows selecting - blocks. It follows native Prometheus - relabel-config syntax. See format details: + configuration that allows selecting blocks. It + follows native Prometheus relabel-config syntax. + See format details: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. -w, --wait Do not exit after all compactions have been @@ -452,20 +452,20 @@ Flags: Thanos. By default Thanos sets CORS headers to be allowed by all. --web.external-prefix="" Static prefix for all HTML links and redirect - URLs in the bucket web UI interface. - Actual endpoints are still served on / or the - web.route-prefix. This allows thanos bucket - web UI to be served behind a reverse proxy that + URLs in the bucket web UI interface. Actual + endpoints are still served on / or the + web.route-prefix. This allows thanos bucket web + UI to be served behind a reverse proxy that strips a URL sub-path. --web.prefix-header="" Name of HTTP request header used for dynamic - prefixing of UI links and redirects. - This option is ignored if web.external-prefix - argument is set. Security risk: enable - this option only if a reverse proxy in - front of thanos is resetting the header. - The --web.prefix-header=X-Forwarded-Prefix - option can be useful, for example, if Thanos - UI is served via Traefik reverse proxy with + prefixing of UI links and redirects. This option + is ignored if web.external-prefix argument is + set. Security risk: enable this option only if a + reverse proxy in front of thanos is resetting + the header. The + --web.prefix-header=X-Forwarded-Prefix option + can be useful, for example, if Thanos UI is + served via Traefik reverse proxy with PathPrefixStrip option enabled, which sends the stripped prefix value in X-Forwarded-Prefix header. This allows thanos UI to be served on a diff --git a/docs/components/query-frontend.md b/docs/components/query-frontend.md index b79bbcc5ff1..44be77ec312 100644 --- a/docs/components/query-frontend.md +++ b/docs/components/query-frontend.md @@ -186,8 +186,8 @@ improve query parallelization and caching. Flags: --cache-compression-type="" - Use compression in results cache. - Supported values are: 'snappy' and ” (disable + Use compression in results cache. Supported + values are: 'snappy' and ” (disable compression). -h, --help Show context-sensitive help (also try --help-long and --help-man). @@ -207,10 +207,10 @@ Flags: scheduled in parallel by the Frontend. --labels.max-retries-per-request=5 Maximum number of retries for a single - label/series API request; beyond this, - the downstream error is returned. - --labels.partial-response Enable partial response for labels requests - if no partial_response param is specified. + label/series API request; beyond this, the + downstream error is returned. + --labels.partial-response Enable partial response for labels requests if + no partial_response param is specified. --no-labels.partial-response for disabling. --labels.response-cache-config= Alternative to @@ -221,23 +221,23 @@ Flags: Path to YAML file that contains response cache configuration. --labels.response-cache-max-freshness=1m - Most recent allowed cacheable result for - labels requests, to prevent caching very recent + Most recent allowed cacheable result for labels + requests, to prevent caching very recent results that might still be in flux. --labels.split-interval=24h Split labels requests by an interval and - execute in parallel, it should be greater - than 0 when labels.response-cache-config is + execute in parallel, it should be greater than + 0 when labels.response-cache-config is configured. --log.format=logfmt Log format to use. Possible options: logfmt or json. --log.level=info Log filtering level. - --log.request.decision= Deprecation Warning - This flag would - be soon deprecated, and replaced with - `request.logging-config`. Request Logging - for logging the start and end of requests. - By default this flag is disabled. LogFinishCall - : Logs the finish call of the requests. + --log.request.decision= Deprecation Warning - This flag would be soon + deprecated, and replaced with + `request.logging-config`. Request Logging for + logging the start and end of requests. By + default this flag is disabled. LogFinishCall : + Logs the finish call of the requests. LogStartAndFinishCall : Logs the start and finish call of the requests. NoLogCall : Disable request logging. @@ -270,26 +270,26 @@ Flags: enable on all queries. --query-frontend.org-id-header= ... Request header names used to identify the - source of slow queries (repeated flag). - The values of the header will be added to - the org id field in the slow query log. If - multiple headers match the request, the first - matching arg specified will take precedence. - If no headers match 'anonymous' will be used. + source of slow queries (repeated flag). The + values of the header will be added to the org + id field in the slow query log. If multiple + headers match the request, the first matching + arg specified will take precedence. If no + headers match 'anonymous' will be used. --query-frontend.vertical-shards=QUERY-FRONTEND.VERTICAL-SHARDS - Number of shards to use when - distributing shardable PromQL queries. - For more details, you can refer to - the Vertical query sharding proposal: + Number of shards to use when distributing + shardable PromQL queries. For more details, you + can refer to the Vertical query sharding + proposal: https://thanos.io/tip/proposals-accepted/202205-vertical-query-sharding.md --query-range.align-range-with-step - Mutate incoming queries to align their - start and end with their step for better + Mutate incoming queries to align their start + and end with their step for better cache-ability. Note: Grafana dashboards do that by default. --query-range.horizontal-shards=0 - Split queries in this many requests - when query duration is below + Split queries in this many requests when query + duration is below query-range.max-split-interval. --query-range.max-query-length=0 Limit the query time range (end - start time) @@ -307,11 +307,11 @@ Flags: range longer than this value will be split in multiple requests of this length. --query-range.min-split-interval=0 - Split query range requests above this - interval in query-range.horizontal-shards - requests of equal range. Using - this parameter is not allowed with - query-range.split-interval. One should also set + Split query range requests above this interval + in query-range.horizontal-shards requests of + equal range. Using this parameter is not + allowed with query-range.split-interval. One + should also set query-range.split-min-horizontal-shards to a value greater than 1 to enable splitting. --query-range.partial-response @@ -342,9 +342,9 @@ Flags: configured. --request.logging-config= Alternative to 'request.logging-config-file' - flag (mutually exclusive). Content - of YAML file with request logging - configuration. See format details: + flag (mutually exclusive). Content of YAML file + with request logging configuration. See format + details: https://thanos.io/tip/thanos/logging.md/#configuration --request.logging-config-file= Path to YAML file with request logging @@ -352,12 +352,12 @@ Flags: https://thanos.io/tip/thanos/logging.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. --web.disable-cors Whether to disable CORS headers to be set by diff --git a/docs/components/query.md b/docs/components/query.md index e1c3ac21127..22d60cb73ac 100644 --- a/docs/components/query.md +++ b/docs/components/query.md @@ -262,26 +262,26 @@ Flags: --alert.query-url=ALERT.QUERY-URL The external Thanos Query URL that would be set in all alerts 'Source' field. - --enable-feature= ... Comma separated experimental feature names - to enable.The current list of features is + --enable-feature= ... Comma separated experimental feature names to + enable.The current list of features is query-pushdown. - --endpoint= ... Addresses of statically configured Thanos - API servers (repeatable). The scheme may be + --endpoint= ... Addresses of statically configured Thanos API + servers (repeatable). The scheme may be prefixed with 'dns+' or 'dnssrv+' to detect Thanos API servers through respective DNS lookups. --endpoint-strict= ... Addresses of only statically configured Thanos - API servers that are always used, even if - the health check fails. Useful if you have a + API servers that are always used, even if the + health check fails. Useful if you have a caching layer on top. --grpc-address="0.0.0.0:10901" Listen ip:port address for gRPC endpoints (StoreAPI). Make sure this address is routable from other components. --grpc-client-server-name="" - Server name to verify the hostname on - the returned gRPC certificates. See + Server name to verify the hostname on the + returned gRPC certificates. See https://tools.ietf.org/html/rfc4366#section-3.1 --grpc-client-tls-ca="" TLS CA Certificates to use to verify gRPC servers @@ -297,14 +297,14 @@ Flags: --grpc-grace-period=2m Time to wait after an interrupt received for GRPC Server. --grpc-server-max-connection-age=60m - The grpc server max connection age. - This controls how often to re-read the tls + The grpc server max connection age. This + controls how often to re-read the tls certificates and redo the TLS handshake --grpc-server-tls-cert="" TLS Certificate for gRPC server, leave blank to disable TLS --grpc-server-tls-client-ca="" - TLS CA to verify clients against. If no - client CA is specified, there is no client + TLS CA to verify clients against. If no client + CA is specified, there is no client verification on server side. (tls.NoClientCert) --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to disable TLS @@ -320,10 +320,10 @@ Flags: --log.format=logfmt Log format to use. Possible options: logfmt or json. --log.level=info Log filtering level. - --log.request.decision= Deprecation Warning - This flag would - be soon deprecated, and replaced with - `request.logging-config`. Request Logging - for logging the start and end of requests. By + --log.request.decision= Deprecation Warning - This flag would be soon + deprecated, and replaced with + `request.logging-config`. Request Logging for + logging the start and end of requests. By default this flag is disabled. LogFinishCall: Logs the finish call of the requests. LogStartAndFinishCall: Logs the start and @@ -340,24 +340,24 @@ Flags: queries. --query.default-step=1s Set default step for range queries. Default step is only used when step is not set in UI. - In such cases, Thanos UI will use default - step to calculate resolution (resolution - = max(rangeSeconds / 250, defaultStep)). - This will not work from Grafana, but Grafana - has __step variable which can be used. + In such cases, Thanos UI will use default step + to calculate resolution (resolution = + max(rangeSeconds / 250, defaultStep)). This + will not work from Grafana, but Grafana has + __step variable which can be used. --query.lookback-delta=QUERY.LOOKBACK-DELTA The maximum lookback duration for retrieving - metrics during expression evaluations. - PromQL always evaluates the query for the - certain timestamp (query range timestamps are - deduced by step). Since scrape intervals might - be different, PromQL looks back for given - amount of time to get latest sample. If it - exceeds the maximum lookback delta it assumes - series is stale and returns none (a gap). - This is why lookback delta should be set to at - least 2 times of the slowest scrape interval. - If unset it will use the promql default of 5m. + metrics during expression evaluations. PromQL + always evaluates the query for the certain + timestamp (query range timestamps are deduced + by step). Since scrape intervals might be + different, PromQL looks back for given amount + of time to get latest sample. If it exceeds the + maximum lookback delta it assumes series is + stale and returns none (a gap). This is why + lookback delta should be set to at least 2 + times of the slowest scrape interval. If unset + it will use the promql default of 5m. --query.max-concurrent=20 Maximum number of queries processed concurrently by query node. --query.max-concurrent-select=4 @@ -369,13 +369,13 @@ Flags: when the range parameters are not specified. The zero value means range covers the time since the beginning. - --query.partial-response Enable partial response for queries if - no partial_response param is specified. + --query.partial-response Enable partial response for queries if no + partial_response param is specified. --no-query.partial-response for disabling. --query.replica-label=QUERY.REPLICA-LABEL ... Labels to treat as a replica indicator along - which data is deduplicated. Still you will - be able to query without deduplication using + which data is deduplicated. Still you will be + able to query without deduplication using 'dedup=false' parameter. Data includes time series, recording rules, and alerting rules. --query.telemetry.request-duration-seconds-quantiles=0.1... ... @@ -390,9 +390,9 @@ Flags: --query.timeout=2m Maximum time to process query by query node. --request.logging-config= Alternative to 'request.logging-config-file' - flag (mutually exclusive). Content - of YAML file with request logging - configuration. See format details: + flag (mutually exclusive). Content of YAML file + with request logging configuration. See format + details: https://thanos.io/tip/thanos/logging.md/#configuration --request.logging-config-file= Path to YAML file with request logging @@ -425,48 +425,48 @@ Flags: Path to files that contain addresses of store API servers. The path can be a glob pattern (repeatable). - --store.sd-interval=5m Refresh interval to re-read file SD files. - It is used as a resync fallback. + --store.sd-interval=5m Refresh interval to re-read file SD files. It + is used as a resync fallback. --store.unhealthy-timeout=5m Timeout before an unhealthy store is cleaned from the store UI page. --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. --web.disable-cors Whether to disable CORS headers to be set by Thanos. By default Thanos sets CORS headers to be allowed by all. - --web.external-prefix="" Static prefix for all HTML links and - redirect URLs in the UI query web interface. - Actual endpoints are still served on / or the + --web.external-prefix="" Static prefix for all HTML links and redirect + URLs in the UI query web interface. Actual + endpoints are still served on / or the web.route-prefix. This allows thanos UI to be served behind a reverse proxy that strips a URL sub-path. --web.prefix-header="" Name of HTTP request header used for dynamic - prefixing of UI links and redirects. - This option is ignored if web.external-prefix - argument is set. Security risk: enable - this option only if a reverse proxy in - front of thanos is resetting the header. - The --web.prefix-header=X-Forwarded-Prefix - option can be useful, for example, if Thanos - UI is served via Traefik reverse proxy with + prefixing of UI links and redirects. This + option is ignored if web.external-prefix + argument is set. Security risk: enable this + option only if a reverse proxy in front of + thanos is resetting the header. The + --web.prefix-header=X-Forwarded-Prefix option + can be useful, for example, if Thanos UI is + served via Traefik reverse proxy with PathPrefixStrip option enabled, which sends the stripped prefix value in X-Forwarded-Prefix header. This allows thanos UI to be served on a sub-path. --web.route-prefix="" Prefix for API and UI endpoints. This allows - thanos UI to be served on a sub-path. - Defaults to the value of --web.external-prefix. - This option is analogous to --web.route-prefix - of Prometheus. + thanos UI to be served on a sub-path. Defaults + to the value of --web.external-prefix. This + option is analogous to --web.route-prefix of + Prometheus. ``` diff --git a/docs/components/receive.md b/docs/components/receive.md index ef4e39e35e3..08bec487b57 100644 --- a/docs/components/receive.md +++ b/docs/components/receive.md @@ -203,20 +203,20 @@ Flags: --grpc-grace-period=2m Time to wait after an interrupt received for GRPC Server. --grpc-server-max-connection-age=60m - The grpc server max connection age. - This controls how often to re-read the tls + The grpc server max connection age. This + controls how often to re-read the tls certificates and redo the TLS handshake --grpc-server-tls-cert="" TLS Certificate for gRPC server, leave blank to disable TLS --grpc-server-tls-client-ca="" - TLS CA to verify clients against. If no - client CA is specified, there is no client + TLS CA to verify clients against. If no client + CA is specified, there is no client verification on server side. (tls.NoClientCert) --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to disable TLS --hash-func= Specify which hash function to use when - calculating the hashes of produced files. - If no function has been specified, it does not + calculating the hashes of produced files. If no + function has been specified, it does not happen. This permits avoiding downloading some files twice albeit at some performance cost. Possible values are: "", "SHA256". @@ -236,14 +236,14 @@ Flags: json. --log.level=info Log filtering level. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --receive.default-tenant-id="default-tenant" Default tenant ID to use when none is provided @@ -261,8 +261,8 @@ Flags: the hashrings. Must be one of hashmod, ketama --receive.hashrings-file= Path to file that contains the hashring - configuration. A watcher is initialized - to watch changes and update the hashring + configuration. A watcher is initialized to + watch changes and update the hashring dynamically. --receive.hashrings-file-refresh-interval=5m Refresh interval to re-read the hashring @@ -287,10 +287,10 @@ Flags: How many times to replicate incoming write requests. --receive.tenant-certificate-field= - Use TLS client's certificate field to - determine tenant for write requests. - Must be one of organization, organizationalUnit - or commonName. This setting will cause the + Use TLS client's certificate field to determine + tenant for write requests. Must be one of + organization, organizationalUnit or commonName. + This setting will cause the receive.tenant-header flag value to be ignored. --receive.tenant-header="THANOS-TENANT" HTTP header to determine tenant for write @@ -301,8 +301,8 @@ Flags: --remote-write.address="0.0.0.0:19291" Address to listen on for remote write requests. --remote-write.client-server-name="" - Server name to verify the hostname - on the returned TLS certificates. See + Server name to verify the hostname on the + returned TLS certificates. See https://tools.ietf.org/html/rfc4366#section-3.1 --remote-write.client-tls-ca="" TLS CA Certificates to use to verify servers. @@ -315,17 +315,17 @@ Flags: TLS Certificate for HTTP server, leave blank to disable TLS. --remote-write.server-tls-client-ca="" - TLS CA to verify clients against. If no - client CA is specified, there is no client + TLS CA to verify clients against. If no client + CA is specified, there is no client verification on server side. (tls.NoClientCert) --remote-write.server-tls-key="" TLS Key for the HTTP server, leave blank to disable TLS. --request.logging-config= Alternative to 'request.logging-config-file' - flag (mutually exclusive). Content - of YAML file with request logging - configuration. See format details: + flag (mutually exclusive). Content of YAML file + with request logging configuration. See format + details: https://thanos.io/tip/thanos/logging.md/#configuration --request.logging-config-file= Path to YAML file with request logging @@ -333,12 +333,12 @@ Flags: https://thanos.io/tip/thanos/logging.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tsdb.allow-overlapping-blocks Allow overlapping blocks, which in turn enables @@ -357,11 +357,11 @@ Flags: next startup. --tsdb.path="./data" Data directory of TSDB. --tsdb.retention=15d How long to retain raw samples on local - storage. 0d - disables this retention. - For more details on how retention is - enforced for individual tenants, please - refer to the Tenant lifecycle management - section in the Receive documentation: + storage. 0d - disables this retention. For more + details on how retention is enforced for + individual tenants, please refer to the Tenant + lifecycle management section in the Receive + documentation: https://thanos.io/tip/components/receive.md/#tenant-lifecycle-management --tsdb.wal-compression Compress the tsdb WAL. --version Show application version. diff --git a/docs/components/rule.md b/docs/components/rule.md index 1badd787e63..72e27cd7556 100644 --- a/docs/components/rule.md +++ b/docs/components/rule.md @@ -263,8 +263,8 @@ and storing old blocks in bucket. Flags: --alert.label-drop=ALERT.LABEL-DROP ... - Labels by name to drop before sending - to alertmanager. This allows alert to be + Labels by name to drop before sending to + alertmanager. This allows alert to be deduplicated on replica label (repeated). Similar Prometheus alert relabelling --alert.query-url=ALERT.QUERY-URL @@ -278,20 +278,20 @@ Flags: Path to YAML file that contains alert relabelling configuration. --alertmanagers.config= - Alternative to 'alertmanagers.config-file' - flag (mutually exclusive). Content - of YAML file that contains alerting - configuration. See format details: + Alternative to 'alertmanagers.config-file' flag + (mutually exclusive). Content of 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 + If defined, it takes precedence over the + '--alertmanagers.url' and '--alertmanagers.send-timeout' flags. --alertmanagers.config-file= Path to 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 + If defined, it takes precedence over the + '--alertmanagers.url' and '--alertmanagers.send-timeout' flags. --alertmanagers.sd-dns-interval=30s Interval between DNS resolutions of @@ -300,14 +300,14 @@ Flags: Timeout for sending alerts to Alertmanager --alertmanagers.url=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 + 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 + 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. --data-dir="data/" data directory --eval-interval=1m The default evaluation interval to use. @@ -320,14 +320,14 @@ Flags: --grpc-server-tls-cert="" TLS Certificate for gRPC server, leave blank to disable TLS --grpc-server-tls-client-ca="" - TLS CA to verify clients against. If no - client CA is specified, there is no client + TLS CA to verify clients against. If no client + CA is specified, there is no client verification on server side. (tls.NoClientCert) --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to disable TLS --hash-func= Specify which hash function to use when - calculating the hashes of produced files. - If no function has been specified, it does not + calculating the hashes of produced files. If no + function has been specified, it does not happen. This permits avoiding downloading some files twice albeit at some performance cost. Possible values are: "", "SHA256". @@ -348,34 +348,34 @@ Flags: --log.format=logfmt Log format to use. Possible options: logfmt or json. --log.level=info Log filtering level. - --log.request.decision= Deprecation Warning - This flag would - be soon deprecated, and replaced with - `request.logging-config`. Request Logging - for logging the start and end of requests. By + --log.request.decision= Deprecation Warning - This flag would be soon + deprecated, and replaced with + `request.logging-config`. Request Logging for + logging the start and end of requests. By default this flag is disabled. LogFinishCall: Logs the finish call of the requests. LogStartAndFinishCall: Logs the start and finish call of the requests. NoLogCall: Disable request logging. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration - --query= ... Addresses of statically configured query - API servers (repeatable). The scheme may be + --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. --query.config= Alternative to 'query.config-file' flag - (mutually exclusive). Content of YAML - file that contains query API servers - configuration. See format details: + (mutually exclusive). Content of 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. @@ -396,32 +396,32 @@ Flags: --query.sd-interval=5m Refresh interval to re-read file SD files. (used as a fallback) --remote-write.config= - Alternative to 'remote-write.config-file' - flag (mutually exclusive). Content - of YAML config for the remote-write - configurations, that specify servers - where samples should be sent to (see + Alternative to 'remote-write.config-file' flag + (mutually exclusive). Content of YAML config + for the remote-write configurations, that + specify servers where samples should be sent to + (see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write). - This automatically enables stateless mode - for ruler and no series will be stored in the + This automatically enables stateless mode for + ruler and no series will be stored in the ruler's TSDB. If an empty config (or file) is provided, the flag is ignored and ruler is run with its own TSDB. --remote-write.config-file= Path to YAML config for the remote-write - configurations, that specify servers - where samples should be sent to (see + configurations, that specify servers where + samples should be sent to (see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write). - This automatically enables stateless mode - for ruler and no series will be stored in the + This automatically enables stateless mode for + ruler and no series will be stored in the ruler's TSDB. If an empty config (or file) is provided, the flag is ignored and ruler is run with its own TSDB. --request.logging-config= Alternative to 'request.logging-config-file' - flag (mutually exclusive). Content - of YAML file with request logging - configuration. See format details: + flag (mutually exclusive). Content of YAML file + with request logging configuration. See format + details: https://thanos.io/tip/thanos/logging.md/#configuration --request.logging-config-file= Path to YAML file with request logging @@ -429,10 +429,10 @@ Flags: https://thanos.io/tip/thanos/logging.md/#configuration --resend-delay=1m Minimum amount of time to wait before resending an alert to Alertmanager. - --rule-file=rules/ ... Rule files that should be used by rule - manager. Can be in glob format (repeated). - Note that rules are not automatically detected, - use SIGHUP or do HTTP POST /-/reload to re-read + --rule-file=rules/ ... Rule files that should be used by rule manager. + Can be in glob format (repeated). Note that + rules are not automatically detected, use + SIGHUP or do HTTP POST /-/reload to re-read them. --shipper.upload-compacted If true shipper will try to upload compacted @@ -442,12 +442,12 @@ Flags: flag when done. --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tsdb.block-duration=2h Block duration for TSDB block. --tsdb.no-lockfile Do not create lockfile in TSDB data directory. @@ -460,20 +460,20 @@ Flags: Thanos. By default Thanos sets CORS headers to be allowed by all. --web.external-prefix="" Static prefix for all HTML links and redirect - URLs in the bucket web UI interface. - Actual endpoints are still served on / or the - web.route-prefix. This allows thanos bucket - web UI to be served behind a reverse proxy that + URLs in the bucket web UI interface. Actual + endpoints are still served on / or the + web.route-prefix. This allows thanos bucket web + UI to be served behind a reverse proxy that strips a URL sub-path. --web.prefix-header="" Name of HTTP request header used for dynamic - prefixing of UI links and redirects. - This option is ignored if web.external-prefix - argument is set. Security risk: enable - this option only if a reverse proxy in - front of thanos is resetting the header. - The --web.prefix-header=X-Forwarded-Prefix - option can be useful, for example, if Thanos - UI is served via Traefik reverse proxy with + prefixing of UI links and redirects. This + option is ignored if web.external-prefix + argument is set. Security risk: enable this + option only if a reverse proxy in front of + thanos is resetting the header. The + --web.prefix-header=X-Forwarded-Prefix option + can be useful, for example, if Thanos UI is + served via Traefik reverse proxy with PathPrefixStrip option enabled, which sends the stripped prefix value in X-Forwarded-Prefix header. This allows thanos UI to be served on a diff --git a/docs/components/sidecar.md b/docs/components/sidecar.md index d5aed396346..d0aafaeabe2 100644 --- a/docs/components/sidecar.md +++ b/docs/components/sidecar.md @@ -85,14 +85,14 @@ Flags: --grpc-server-tls-cert="" TLS Certificate for gRPC server, leave blank to disable TLS --grpc-server-tls-client-ca="" - TLS CA to verify clients against. If no - client CA is specified, there is no client + TLS CA to verify clients against. If no client + CA is specified, there is no client verification on server side. (tls.NoClientCert) --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to disable TLS --hash-func= Specify which hash function to use when - calculating the hashes of produced files. - If no function has been specified, it does not + calculating the hashes of produced files. If no + function has been specified, it does not happen. This permits avoiding downloading some files twice albeit at some performance cost. Possible values are: "", "SHA256". @@ -116,14 +116,14 @@ Flags: relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --prometheus.get_config_interval=30s How often to get Prometheus config @@ -131,20 +131,20 @@ Flags: Timeout for getting Prometheus config --prometheus.http-client= Alternative to 'prometheus.http-client-file' - flag (mutually exclusive). Content - of YAML file or string with http - client configs. See Format details: + flag (mutually exclusive). Content of YAML file + or string with http client configs. See Format + details: https://thanos.io/tip/components/sidecar.md/#configuration. --prometheus.http-client-file= - Path to YAML file or string with http - client configs. See Format details: + Path to YAML file or string with http client + configs. See Format details: https://thanos.io/tip/components/sidecar.md/#configuration. --prometheus.ready_timeout=10m Maximum time to wait for the Prometheus instance to start up --prometheus.url=http://localhost:9090 - URL at which to reach Prometheus's API. - For better performance use local network. + URL at which to reach Prometheus's API. For + better performance use local network. --reloader.config-envsubst-file="" Output file for environment variable substituted config file. @@ -160,9 +160,9 @@ Flags: rules. --request.logging-config= Alternative to 'request.logging-config-file' - flag (mutually exclusive). Content - of YAML file with request logging - configuration. See format details: + flag (mutually exclusive). Content of YAML file + with request logging configuration. See format + details: https://thanos.io/tip/thanos/logging.md/#configuration --request.logging-config-file= Path to YAML file with request logging @@ -176,12 +176,12 @@ Flags: flag when done. --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tsdb.path="./data" Data directory of TSDB. --version Show application version. diff --git a/docs/components/store.md b/docs/components/store.md index 1460d142c3f..6543144a699 100644 --- a/docs/components/store.md +++ b/docs/components/store.md @@ -36,15 +36,15 @@ Flags: Number of goroutines to use when constructing index-cache.json blocks from object storage. Must be equal or greater than 1. - --chunk-pool-size=2GB Maximum size of concurrently allocatable - bytes reserved strictly to reuse for chunks in + --chunk-pool-size=2GB Maximum size of concurrently allocatable bytes + reserved strictly to reuse for chunks in memory. - --consistency-delay=0s Minimum age of all blocks before they are - being read. Set it to safe value (e.g 30m) if - your object storage is eventually consistent. - GCS and S3 are (roughly) strongly consistent. - --data-dir="./data" Local data directory used for caching - purposes (index-header, in-mem cache items and + --consistency-delay=0s Minimum age of all blocks before they are being + read. Set it to safe value (e.g 30m) if your + object storage is eventually consistent. GCS + and S3 are (roughly) strongly consistent. + --data-dir="./data" Local data directory used for caching purposes + (index-header, in-mem cache items and meta.jsons). If removed, no data will be lost, just store will have to rebuild the cache. NOTE: Putting raw blocks here will not cause @@ -59,8 +59,8 @@ Flags: --grpc-server-tls-cert="" TLS Certificate for gRPC server, leave blank to disable TLS --grpc-server-tls-client-ca="" - TLS CA to verify clients against. If no - client CA is specified, there is no client + TLS CA to verify clients against. If no client + CA is specified, there is no client verification on server side. (tls.NoClientCert) --grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to disable TLS @@ -80,32 +80,32 @@ Flags: is to ignore blocks that are marked for deletion with some delay. This ensures store can still serve blocks that are meant to be - deleted but do not have a replacement yet. - If delete-delay duration is provided to - compactor or bucket verify component, - it will upload deletion-mark.json file to - mark after what duration the block should - be deleted rather than deleting the block - straight away. If delete-delay is non-zero - for compactor or bucket verify component, - ignore-deletion-marks-delay should be set - to (delete-delay)/2 so that blocks marked - for deletion are filtered out while fetching - blocks before being deleted from bucket. - Default is 24h, half of the default value for + deleted but do not have a replacement yet. If + delete-delay duration is provided to compactor + or bucket verify component, it will upload + deletion-mark.json file to mark after what + duration the block should be deleted rather + than deleting the block straight away. If + delete-delay is non-zero for compactor or + bucket verify component, + ignore-deletion-marks-delay should be set to + (delete-delay)/2 so that blocks marked for + deletion are filtered out while fetching blocks + before being deleted from bucket. Default is + 24h, half of the default value for --delete-delay on compactor. --index-cache-size=250MB Maximum size of items held in the in-memory index cache. Ignored if --index-cache.config or --index-cache.config-file option is specified. --index-cache.config= - Alternative to 'index-cache.config-file' - flag (mutually exclusive). Content of - YAML file that contains index cache - configuration. See format details: + Alternative to 'index-cache.config-file' flag + (mutually exclusive). Content of YAML file that + contains index cache configuration. See format + details: https://thanos.io/tip/components/store.md/#index-cache --index-cache.config-file= - Path to YAML file that contains index - cache configuration. See format details: + Path to YAML file that contains index cache + configuration. See format details: https://thanos.io/tip/components/store.md/#index-cache --log.format=logfmt Log format to use. Possible options: logfmt or json. @@ -114,8 +114,8 @@ Flags: End of time range limit to serve. Thanos Store will serve only blocks, which happened earlier 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 + 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. --min-time=0000-01-01T00:00:00Z Start of time range limit to serve. Thanos @@ -125,20 +125,20 @@ Flags: relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --request.logging-config= Alternative to 'request.logging-config-file' - flag (mutually exclusive). Content - of YAML file with request logging - configuration. See format details: + flag (mutually exclusive). Content of YAML file + with request logging configuration. See format + details: https://thanos.io/tip/thanos/logging.md/#configuration --request.logging-config-file= Path to YAML file with request logging @@ -146,17 +146,17 @@ Flags: https://thanos.io/tip/thanos/logging.md/#configuration --selector.relabel-config= Alternative to 'selector.relabel-config-file' - flag (mutually exclusive). Content of - YAML file that contains relabeling - configuration that allows selecting - blocks. It follows native Prometheus - relabel-config syntax. See format details: + flag (mutually exclusive). Content of YAML file + that contains relabeling configuration that + allows selecting blocks. It follows native + Prometheus relabel-config syntax. See format + details: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config --selector.relabel-config-file= Path to YAML file that contains relabeling - configuration that allows selecting - blocks. It follows native Prometheus - relabel-config syntax. See format details: + configuration that allows selecting blocks. It + follows native Prometheus relabel-config + syntax. See format details: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config --store.enable-index-header-lazy-reader If true, Store Gateway will lazy memory map @@ -165,29 +165,29 @@ Flags: --store.grpc.series-max-concurrency=20 Maximum number of concurrent Series calls. --store.grpc.series-sample-limit=0 - Maximum amount of samples returned via a - single Series call. The Series call fails - if this limit is exceeded. 0 means no limit. - NOTE: For efficiency the limit is internally - implemented as 'chunks limit' considering - each chunk contains 120 samples (it's the max - number of samples each chunk can contain), - so the actual number of samples might be lower, - even though the maximum could be hit. + Maximum amount of samples returned via a single + Series call. The Series call fails if this + limit is exceeded. 0 means no limit. NOTE: For + efficiency the limit is internally implemented + as 'chunks limit' considering each chunk + contains 120 samples (it's the max number of + samples each chunk can contain), so the actual + number of samples might be lower, even though + the maximum could be hit. --store.grpc.touched-series-limit=0 - Maximum amount of touched series returned via - a single Series call. The Series call fails if + Maximum amount of touched series returned via a + single Series call. The Series call fails if this limit is exceeded. 0 means no limit. --sync-block-duration=3m Repeat interval for syncing the blocks between local and remote view. --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. --web.disable Disable Block Viewer UI. @@ -195,20 +195,20 @@ Flags: Thanos. By default Thanos sets CORS headers to be allowed by all. --web.external-prefix="" Static prefix for all HTML links and redirect - URLs in the bucket web UI interface. - Actual endpoints are still served on / or the - web.route-prefix. This allows thanos bucket - web UI to be served behind a reverse proxy that + URLs in the bucket web UI interface. Actual + endpoints are still served on / or the + web.route-prefix. This allows thanos bucket web + UI to be served behind a reverse proxy that strips a URL sub-path. --web.prefix-header="" Name of HTTP request header used for dynamic - prefixing of UI links and redirects. - This option is ignored if web.external-prefix - argument is set. Security risk: enable - this option only if a reverse proxy in - front of thanos is resetting the header. - The --web.prefix-header=X-Forwarded-Prefix - option can be useful, for example, if Thanos - UI is served via Traefik reverse proxy with + prefixing of UI links and redirects. This + option is ignored if web.external-prefix + argument is set. Security risk: enable this + option only if a reverse proxy in front of + thanos is resetting the header. The + --web.prefix-header=X-Forwarded-Prefix option + can be useful, for example, if Thanos UI is + served via Traefik reverse proxy with PathPrefixStrip option enabled, which sends the stripped prefix value in X-Forwarded-Prefix header. This allows thanos UI to be served on a diff --git a/docs/components/tools.md b/docs/components/tools.md index b137f1e40ac..776164aeb00 100644 --- a/docs/components/tools.md +++ b/docs/components/tools.md @@ -17,13 +17,13 @@ Flags: --log.format=logfmt Log format to use. Possible options: logfmt or json. --log.level=info Log filtering level. --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -58,13 +58,13 @@ Subcommands: potentially a noop. tools bucket rewrite --id=ID [] - Rewrite chosen blocks in the bucket, while deleting or modifying - series Resulted block has modified stats in meta.json. Additionally - compaction.sources are altered to not confuse readers of meta.json. - Instead thanos.rewrite section is added with useful info like old sources - and deletion requests. NOTE: It's recommended to turn off compactor while - doing this operation. If the compactor is running and touching exactly same - block that is being rewritten, the resulted rewritten block might only cause + Rewrite chosen blocks in the bucket, while deleting or modifying series + Resulted block has modified stats in meta.json. Additionally + compaction.sources are altered to not confuse readers of meta.json. Instead + thanos.rewrite section is added with useful info like old sources and + deletion requests. NOTE: It's recommended to turn off compactor while doing + this operation. If the compactor is running and touching exactly same block + that is being rewritten, the resulted rewritten block might only cause overlap (mitigated by marking overlapping block manually for deletion) and the data you wanted to rewrite could already part of bigger block. @@ -118,21 +118,21 @@ Flags: --log.level=info Log filtering level. --objstore.config= Alternative to 'objstore.config-file' flag (mutually - exclusive). Content of YAML file that contains - object store configuration. See format details: + exclusive). Content of YAML file that contains object + store configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -167,13 +167,13 @@ Subcommands: potentially a noop. tools bucket rewrite --id=ID [] - Rewrite chosen blocks in the bucket, while deleting or modifying - series Resulted block has modified stats in meta.json. Additionally - compaction.sources are altered to not confuse readers of meta.json. - Instead thanos.rewrite section is added with useful info like old sources - and deletion requests. NOTE: It's recommended to turn off compactor while - doing this operation. If the compactor is running and touching exactly same - block that is being rewritten, the resulted rewritten block might only cause + Rewrite chosen blocks in the bucket, while deleting or modifying series + Resulted block has modified stats in meta.json. Additionally + compaction.sources are altered to not confuse readers of meta.json. Instead + thanos.rewrite section is added with useful info like old sources and + deletion requests. NOTE: It's recommended to turn off compactor while doing + this operation. If the compactor is running and touching exactly same block + that is being rewritten, the resulted rewritten block might only cause overlap (mitigated by marking overlapping block manually for deletion) and the data you wanted to rewrite could already part of bigger block. @@ -224,84 +224,84 @@ Flags: json. --log.level=info Log filtering level. --max-time=9999-12-31T23:59:59Z - End of time range limit to serve. Thanos - tool bucket web will serve only blocks, - which happened earlier than this value. Option - can be a constant time in RFC3339 format or time + End of time range limit to serve. Thanos tool + bucket web will serve only blocks, which + happened earlier 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. --min-time=0000-01-01T00:00:00Z - Start of time range limit to serve. Thanos - tool bucket web will serve only blocks, which + Start of time range limit to serve. Thanos tool + bucket web will serve only blocks, 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. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --refresh=30m Refresh interval to download metadata from remote storage --selector.relabel-config= Alternative to 'selector.relabel-config-file' - flag (mutually exclusive). Content of - YAML file that contains relabeling - configuration that allows selecting - blocks. It follows native Prometheus - relabel-config syntax. See format details: + flag (mutually exclusive). Content of YAML file + that contains relabeling configuration that + allows selecting blocks. It follows native + Prometheus relabel-config syntax. See format + details: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config --selector.relabel-config-file= Path to YAML file that contains relabeling - configuration that allows selecting - blocks. It follows native Prometheus - relabel-config syntax. See format details: + configuration that allows selecting blocks. It + follows native Prometheus relabel-config syntax. + See format details: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config --timeout=5m Timeout to download metadata from remote storage --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. --web.disable-cors Whether to disable CORS headers to be set by Thanos. By default Thanos sets CORS headers to be allowed by all. --web.external-prefix="" Static prefix for all HTML links and redirect - URLs in the bucket web UI interface. - Actual endpoints are still served on / or the - web.route-prefix. This allows thanos bucket - web UI to be served behind a reverse proxy that + URLs in the bucket web UI interface. Actual + endpoints are still served on / or the + web.route-prefix. This allows thanos bucket web + UI to be served behind a reverse proxy that strips a URL sub-path. --web.prefix-header="" Name of HTTP request header used for dynamic - prefixing of UI links and redirects. - This option is ignored if web.external-prefix - argument is set. Security risk: enable - this option only if a reverse proxy in - front of thanos is resetting the header. - The --web.prefix-header=X-Forwarded-Prefix - option can be useful, for example, if Thanos - UI is served via Traefik reverse proxy with + prefixing of UI links and redirects. This option + is ignored if web.external-prefix argument is + set. Security risk: enable this option only if a + reverse proxy in front of thanos is resetting + the header. The + --web.prefix-header=X-Forwarded-Prefix option + can be useful, for example, if Thanos UI is + served via Traefik reverse proxy with PathPrefixStrip option enabled, which sends the stripped prefix value in X-Forwarded-Prefix header. This allows thanos UI to be served on a sub-path. --web.route-prefix="" Prefix for API and UI endpoints. This allows - thanos UI to be served on a sub-path. - Defaults to the value of --web.external-prefix. - This option is analogous to --web.route-prefix - of Prometheus. + thanos UI to be served on a sub-path. Defaults + to the value of --web.external-prefix. This + option is analogous to --web.route-prefix of + Prometheus. ``` @@ -325,22 +325,22 @@ issue this might take time and will need downloading all specified blocks to disk. Flags: - --delete-delay=0s Duration after which blocks marked for deletion - would be deleted permanently from source bucket by + --delete-delay=0s Duration after which blocks marked for deletion would + be deleted permanently from source bucket by compactor component. If delete-delay is non zero, blocks will be marked for deletion and compactor component is required to delete blocks from source bucket. If delete-delay is 0, blocks will be deleted - straight away. Use this if you want to get rid of - or move the block immediately. Note that deleting - blocks immediately can cause query failures, if store + straight away. Use this if you want to get rid of or + move the block immediately. Note that deleting blocks + immediately can cause query failures, if store gateway still has the block loaded, or compactor is ignoring the deletion because it's compacting the block at the same time. -h, --help Show context-sensitive help (also try --help-long and --help-man). - --id=ID ... Block IDs to verify (and optionally repair) only. - If none is specified, all blocks will be verified. + --id=ID ... Block IDs to verify (and optionally repair) only. If + none is specified, all blocks will be verified. Repeated field -i, --issues=index_known_issues... ... Issues to verify (and optionally repair). Possible @@ -350,38 +350,38 @@ Flags: --log.format=logfmt Log format to use. Possible options: logfmt or json. --log.level=info Log filtering level. --objstore-backup.config= - Alternative to 'objstore-backup.config-file' - flag (mutually exclusive). Content of YAML - file that contains object store-backup - configuration. See format details: + Alternative to 'objstore-backup.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store-backup configuration. See + format details: https://thanos.io/tip/thanos/storage.md/#configuration Used for repair logic to backup blocks before removal. --objstore-backup.config-file= - Path to YAML file that contains object - store-backup configuration. See format details: + Path to YAML file that contains object store-backup + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration Used for repair logic to backup blocks before removal. --objstore.config= Alternative to 'objstore.config-file' flag (mutually - exclusive). Content of YAML file that contains - object store configuration. See format details: + exclusive). Content of YAML file that contains object + store configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration -r, --repair Attempt to repair blocks for which issues were detected --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -410,24 +410,24 @@ Flags: --log.level=info Log filtering level. --objstore.config= Alternative to 'objstore.config-file' flag (mutually - exclusive). Content of YAML file that contains - object store configuration. See format details: + exclusive). Content of YAML file that contains object + store configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: 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. --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -455,14 +455,14 @@ Flags: json. --log.level=info Log filtering level. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --output=table Output format for result. Currently supports table, cvs, tsv. @@ -476,13 +476,13 @@ Flags: are then further sorted by the 'UNTIL' value. --timeout=5m Timeout to download metadata from remote storage --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -532,54 +532,54 @@ Flags: --matcher=key="value" ... Only blocks whose external labels exactly match this matcher will be replicated. --max-time=9999-12-31T23:59:59Z - End of time range limit to replicate. - Thanos Replicate will replicate only metrics, - which happened earlier 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. + End of time range limit to replicate. Thanos + Replicate will replicate only metrics, which + happened earlier 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. --min-time=0000-01-01T00:00:00Z - Start of time range limit to replicate. - Thanos Replicate will replicate 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. + Start of time range limit to replicate. Thanos + Replicate will replicate 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. --objstore-to.config= - Alternative to 'objstore-to.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store-to - configuration. See format details: + Alternative to 'objstore-to.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store-to configuration. See + format details: https://thanos.io/tip/thanos/storage.md/#configuration The object storage which replicate data to. --objstore-to.config-file= - Path to YAML file that contains object - store-to configuration. See format details: + Path to YAML file that contains object store-to + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration The object storage which replicate data to. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --resolution=0s... ... Only blocks with these resolutions will be replicated. Repeated flag. --single-run Run replication only one time, then exit. --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -628,30 +628,30 @@ Flags: Listen host:port for HTTP endpoints. --http-grace-period=2m Time to wait after an interrupt received for HTTP Server. - --http.config="" [EXPERIMENTAL] Path to the configuration file - that can enable TLS or authentication for all HTTP + --http.config="" [EXPERIMENTAL] Path to the configuration file that + can enable TLS or authentication for all HTTP endpoints. --log.format=logfmt Log format to use. Possible options: logfmt or json. --log.level=info Log filtering level. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. --wait-interval=5m Wait interval between downsample runs. @@ -698,21 +698,21 @@ Flags: --marker=MARKER Marker to be put. --objstore.config= Alternative to 'objstore.config-file' flag (mutually - exclusive). Content of YAML file that contains - object store configuration. See format details: + exclusive). Content of YAML file that contains object + store configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -748,8 +748,8 @@ usage: thanos tools bucket rewrite --id=ID [] Rewrite chosen blocks in the bucket, while deleting or modifying series Resulted block has modified stats in meta.json. Additionally compaction.sources are -altered to not confuse readers of meta.json. Instead thanos.rewrite section -is added with useful info like old sources and deletion requests. NOTE: It's +altered to not confuse readers of meta.json. Instead thanos.rewrite section is +added with useful info like old sources and deletion requests. NOTE: It's recommended to turn off compactor while doing this operation. If the compactor is running and touching exactly same block that is being rewritten, the resulted rewritten block might only cause overlap (mitigated by marking overlapping block @@ -769,11 +769,11 @@ Flags: Defaults to true, for user to double check. (: Pass --no-dry-run to skip this. --hash-func= Specify which hash function to use when - calculating the hashes of produced files. - If no function has been specified, it does not - happen. This permits avoiding downloading some - files twice albeit at some performance cost. - Possible values are: "", "SHA256". + calculating the hashes of produced files. If no + function has been specified, it does not happen. + This permits avoiding downloading some files + twice albeit at some performance cost. Possible + values are: "", "SHA256". -h, --help Show context-sensitive help (also try --help-long and --help-man). --id=ID ... ID (ULID) of the blocks for rewrite (repeated @@ -782,14 +782,14 @@ Flags: json. --log.level=info Log filtering level. --objstore.config= - Alternative to 'objstore.config-file' - flag (mutually exclusive). Content of - YAML file that contains object store - configuration. See format details: + Alternative to 'objstore.config-file' flag + (mutually exclusive). Content of YAML file that + contains object store configuration. See format + details: https://thanos.io/tip/thanos/storage.md/#configuration --objstore.config-file= - Path to YAML file that contains object - store configuration. See format details: + Path to YAML file that contains object store + configuration. See format details: https://thanos.io/tip/thanos/storage.md/#configuration --prom-blocks If specified, we assume the blocks to be uploaded are only used with Prometheus so we @@ -808,8 +808,8 @@ Flags: to blocks --rewrite.to-relabel-config= Alternative to 'rewrite.to-relabel-config-file' - flag (mutually exclusive). Content of YAML - file that contains relabel configs that will be + flag (mutually exclusive). Content of YAML file + that contains relabel configs that will be applied to blocks --rewrite.to-relabel-config-file= Path to YAML file that contains relabel configs @@ -818,12 +818,12 @@ Flags: Working directory for temporary files --tracing.config= Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + (mutually exclusive). Content of YAML file with + tracing configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. + See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. @@ -857,13 +857,13 @@ Flags: --log.level=info Log filtering level. --rules=RULES ... The rule files glob to check (repeated). --tracing.config= - Alternative to 'tracing.config-file' flag - (mutually exclusive). Content of YAML file - with tracing configuration. See format details: + Alternative to 'tracing.config-file' flag (mutually + exclusive). Content of YAML file with tracing + configuration. See format details: https://thanos.io/tip/thanos/tracing.md/#configuration --tracing.config-file= - Path to YAML file with tracing - configuration. See format details: + Path to YAML file with tracing configuration. See + format details: https://thanos.io/tip/thanos/tracing.md/#configuration --version Show application version. diff --git a/go.mod b/go.mod index 107dfe85d34..bee3e97fe70 100644 --- a/go.mod +++ b/go.mod @@ -283,4 +283,4 @@ replace ( // From Prometheus. k8s.io/klog => github.com/simonpasquier/klog-gokit v0.3.0 k8s.io/klog/v2 => github.com/simonpasquier/klog-gokit/v3 v3.0.0 -) \ No newline at end of file +)