Skip to content

Commit

Permalink
Sync docs
Browse files Browse the repository at this point in the history
Signed-off-by: Xiaochao Dong (@damnever) <[email protected]>
  • Loading branch information
damnever committed Jan 25, 2024
1 parent 135a1af commit 44ca87c
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/components/query-frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ Query Frontend supports caching query results and reuses them on subsequent quer
#### In-memory

```yaml mdox-exec="go run scripts/cfggen/main.go --name=queryfrontend.InMemoryResponseCacheConfig"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: IN-MEMORY
config:
max_size: ""
Expand All @@ -65,6 +67,8 @@ Example configuration: [kube-thanos](https://github.com/thanos-io/kube-thanos/bl
#### Memcached

```yaml mdox-exec="go run scripts/cfggen/main.go --name=queryfrontend.MemcachedResponseCacheConfig"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: MEMCACHED
config:
addresses: []
Expand All @@ -77,6 +81,12 @@ config:
max_get_multi_batch_size: 0
dns_provider_update_interval: 0s
auto_discovery: false
set_async_circuit_breaker_enabled: false
set_async_circuit_breaker_half_open_max_requests: 0
set_async_circuit_breaker_open_duration: 0s
set_async_circuit_breaker_min_requests: 0
set_async_circuit_breaker_consecutive_failures: 0
set_async_circuit_breaker_failure_percent: 0
expiration: 0s
```

Expand Down Expand Up @@ -108,6 +118,8 @@ config:
The default redis config is:
```yaml mdox-exec="go run scripts/cfggen/main.go --name=queryfrontend.RedisResponseCacheConfig"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: REDIS
config:
addr: ""
Expand All @@ -132,6 +144,12 @@ config:
master_name: ""
max_async_buffer_size: 10000
max_async_concurrency: 20
set_async_circuit_breaker_enabled: false
set_async_circuit_breaker_half_open_max_requests: 10
set_async_circuit_breaker_open_duration: 5s
set_async_circuit_breaker_min_requests: 50
set_async_circuit_breaker_consecutive_failures: 5
set_async_circuit_breaker_failure_percent: 0.05
expiration: 24h0m0s
```
Expand Down
2 changes: 2 additions & 0 deletions docs/components/receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ where `<thanos-receive-containter-ip>` is an IP address reachable by Prometheus
The example content of `bucket.yml`:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down
2 changes: 2 additions & 0 deletions docs/components/sidecar.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ thanos sidecar \
The example content of `bucket.yml`:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down
20 changes: 20 additions & 0 deletions docs/components/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ thanos store \
The content of `bucket.yml`:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down Expand Up @@ -293,6 +295,8 @@ The `in-memory` index cache is enabled by default and its max size can be config
Alternatively, the `in-memory` index cache can also be configured using `--index-cache.config-file` to reference the configuration file or `--index-cache.config` to put yaml config directly:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=storecache.InMemoryIndexCacheConfig"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: IN-MEMORY
config:
max_size: 0
Expand All @@ -313,6 +317,8 @@ All the settings are **optional**:
The `memcached` index cache allows to use [Memcached](https://memcached.org) as cache backend. This cache type is configured using `--index-cache.config-file` to reference the configuration file or `--index-cache.config` to put yaml config directly:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=cacheutil.MemcachedClientConfig"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: MEMCACHED
config:
addresses: []
Expand All @@ -325,6 +331,12 @@ config:
max_get_multi_batch_size: 0
dns_provider_update_interval: 0s
auto_discovery: false
set_async_circuit_breaker_enabled: false
set_async_circuit_breaker_half_open_max_requests: 0
set_async_circuit_breaker_open_duration: 0s
set_async_circuit_breaker_min_requests: 0
set_async_circuit_breaker_consecutive_failures: 0
set_async_circuit_breaker_failure_percent: 0
enabled_items: []
ttl: 0s
```
Expand Down Expand Up @@ -352,6 +364,8 @@ While the remaining settings are **optional**:
The `redis` index cache allows to use [Redis](https://redis.io) as cache backend. This cache type is configured using `--index-cache.config-file` to reference the configuration file or `--index-cache.config` to put yaml config directly:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=cacheutil.RedisClientConfig"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: REDIS
config:
addr: ""
Expand All @@ -376,6 +390,12 @@ config:
master_name: ""
max_async_buffer_size: 10000
max_async_concurrency: 20
set_async_circuit_breaker_enabled: false
set_async_circuit_breaker_half_open_max_requests: 10
set_async_circuit_breaker_open_duration: 5s
set_async_circuit_breaker_min_requests: 50
set_async_circuit_breaker_consecutive_failures: 5
set_async_circuit_breaker_failure_percent: 0.05
enabled_items: []
ttl: 0s
```
Expand Down
8 changes: 7 additions & 1 deletion docs/components/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ thanos tools bucket verify --objstore.config-file=bucket.yml
The content of `bucket.yml`:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down Expand Up @@ -611,6 +613,8 @@ thanos tools bucket downsample \
The content of `bucket.yml`:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down Expand Up @@ -690,6 +694,8 @@ thanos tools bucket mark \
The example content of `bucket.yml`:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down Expand Up @@ -832,7 +838,7 @@ Flags:
--rewrite.to-relabel-config-file=<file-path>
Path to YAML file that contains relabel configs
that will be applied to blocks
--tmp.dir="/tmp/thanos-rewrite"
--tmp.dir="/var/folders/lr/lr80q5_n46j1txyyn7767dyh0000gn/T/thanos-rewrite"
Working directory for temporary files
--tracing.config=<content>
Alternative to 'tracing.config-file' flag
Expand Down
16 changes: 16 additions & 0 deletions docs/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ You can configure an S3 bucket as an object store with YAML, either by passing t
NOTE: Minio client was mainly for AWS S3, but it can be configured against other S3-compatible object storages e.g Ceph

```yaml mdox-exec="go run scripts/cfggen/main.go --name=s3.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: S3
config:
bucket: ""
Expand Down Expand Up @@ -280,6 +282,8 @@ To configure Google Cloud Storage bucket as an object store you need to set `buc
For example:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=gcs.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GCS
config:
bucket: ""
Expand Down Expand Up @@ -354,6 +358,8 @@ To configure Azure Storage account as an object store you need to provide a path
Config file format is the following:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=azure.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: AZURE
config:
storage_account: ""
Expand Down Expand Up @@ -413,6 +419,8 @@ Below is an example configuration file for thanos to use OpenStack swift contain
By default, OpenStack Swift has a limit for maximum file size of 5 GiB. Thanos index files are often larger than that. To resolve this issue, Thanos uses [Static Large Objects (SLO)](https://docs.openstack.org/swift/latest/overview_large_objects.html) which are uploaded as segments. These are by default put into the `segments` directory of the same container. The default limit for using SLO is 1 GiB which is also the maximum size of the segment. If you don't want to use the same container for the segments (best practise is to use `<container_name>_segments` to avoid polluting listing of the container objects) you can use the `large_file_segments_container_name` option to override the default and put the segments to other container. *In rare cases you can switch to [Dynamic Large Objects (DLO)](https://docs.openstack.org/swift/latest/overview_large_objects.html) by setting the `use_dynamic_large_objects` to true, but use it with caution since it even more relies on eventual consistency.*

```yaml mdox-exec="go run scripts/cfggen/main.go --name=swift.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: SWIFT
config:
auth_version: 0
Expand Down Expand Up @@ -449,6 +457,8 @@ To use Tencent COS as storage store, you should apply a Tencent Account to creat
To configure Tencent Account to use COS as storage store you need to set these parameters in yaml format stored in a file:

```yaml mdox-exec="go run scripts/cfggen/main.go --name=cos.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: COS
config:
bucket: ""
Expand Down Expand Up @@ -489,6 +499,8 @@ In order to use AliYun OSS object storage, you should first create a bucket with
To use AliYun OSS object storage, please specify following yaml configuration file in `objstore.config*` flag.

```yaml mdox-exec="go run scripts/cfggen/main.go --name=oss.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: ALIYUNOSS
config:
endpoint: ""
Expand All @@ -505,6 +517,8 @@ Use --objstore.config-file to reference to this configuration file.
In order to use Baidu BOS object storage, you should apply for a Baidu Account and create an object storage bucket first. Refer to [Baidu Cloud Documents](https://cloud.baidu.com/doc/BOS/index.html) for more details. To use Baidu BOS object storage, please specify the following yaml configuration file in `--objstore.config*` flag.

```yaml mdox-exec="go run scripts/cfggen/main.go --name=bos.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: BOS
config:
bucket: ""
Expand All @@ -521,6 +535,8 @@ This storage type is used when user wants to store and access the bucket in the
NOTE: This storage type is experimental and might be inefficient. It is NOT advised to use it as the main storage for metrics in production environment. Particularly there is no planned support for distributed filesystems like NFS. This is mainly useful for testing and demos.

```yaml mdox-exec="go run scripts/cfggen/main.go --name=filesystem.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: FILESYSTEM
config:
directory: ""
Expand Down
10 changes: 10 additions & 0 deletions docs/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Currently supported tracing backends:
Thanos supports exporting traces in the OpenTelemetry Protocol (OTLP). Both gRPC and HTTP clients are supported. Options can be provided also via environment variables. For more details see the [exporter specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options).

```yaml mdox-exec="go run scripts/cfggen/main.go --name=otlp.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: OTLP
config:
client_type: ""
Expand Down Expand Up @@ -108,6 +110,8 @@ Client for https://github.com/jaegertracing/jaeger tracing. Options can be provi
*WARNING: Options `RPC Metrics`, `Gen128Bit` and `Disabled` are now deprecated and won't have any effect when set*

```yaml mdox-exec="go run scripts/cfggen/main.go --name=jaeger.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: JAEGER
config:
service_name: ""
Expand Down Expand Up @@ -147,6 +151,8 @@ You will also need to ensure that the authentication with the API is working, fo
*Note:* The `type` in the configuration below can have either value `GOOGLE_CLOUD` or `STACKDRIVER` - this is to ensure backwards compatibility.

```yaml mdox-exec="go run scripts/cfggen/main.go --name=google_cloud.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: GOOGLE_CLOUD
config:
service_name: ""
Expand All @@ -159,6 +165,8 @@ config:
Client for https://www.elastic.co/products/apm tracing.

```yaml mdox-exec="go run scripts/cfggen/main.go --name=elasticapm.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: ELASTIC_APM
config:
service_name: ""
Expand All @@ -174,6 +182,8 @@ Client for [Lightstep](https://www.servicenow.com/products/observability.html).
In order to configure Thanos to interact with Lightstep you need to provide at least an [access token](https://docs.lightstep.com/docs/create-and-use-access-tokens) in the configuration file. The `collector` key is optional and used when you have on-premise satellites.

```yaml mdox-exec="go run scripts/cfggen/main.go --name=lightstep.Config"
# command-line-arguments
ld: warning: ignoring duplicate libraries: '-lproc'
type: LIGHTSTEP
config:
access_token: ""
Expand Down

0 comments on commit 44ca87c

Please sign in to comment.