From 32f9f4bf9f3c0339ef45f070710bd172958e2e34 Mon Sep 17 00:00:00 2001 From: zyy17 Date: Tue, 10 Sep 2024 12:54:24 +0800 Subject: [PATCH] docs: use docs comment prefix and bump toml2docs version --- Makefile | 2 +- config/config.md | 22 +++++----- config/datanode.example.toml | 76 ++++++++++++++++++---------------- config/flownode.example.toml | 6 +-- config/frontend.example.toml | 20 ++++----- config/metasrv.example.toml | 6 +-- config/standalone.example.toml | 76 ++++++++++++++++++---------------- 7 files changed, 109 insertions(+), 99 deletions(-) diff --git a/Makefile b/Makefile index acc2a731267c..30d99309d085 100644 --- a/Makefile +++ b/Makefile @@ -221,7 +221,7 @@ config-docs: ## Generate configuration documentation from toml files. docker run --rm \ -v ${PWD}:/greptimedb \ -w /greptimedb/config \ - toml2docs/toml2docs:v0.1.1 \ + toml2docs/toml2docs:v0.1.2 \ -p '##' \ -t ./config-docs-template.md \ -o ./config.md diff --git a/config/config.md b/config/config.md index a792be5de57d..dfa97ff651a1 100644 --- a/config/config.md +++ b/config/config.md @@ -116,12 +116,12 @@ | `region_engine.mito.compress_manifest` | Bool | `false` | Whether to compress manifest and checkpoint file by gzip (default false). | | `region_engine.mito.max_background_jobs` | Integer | `4` | Max number of running background jobs | | `region_engine.mito.auto_flush_interval` | String | `1h` | Interval to auto flush a region if it has not flushed yet. | -| `region_engine.mito.global_write_buffer_size` | String | `1GB` | Global write buffer size for all regions. If not set, it's default to 1/8 of OS memory with a max limitation of 1GB. | -| `region_engine.mito.global_write_buffer_reject_size` | String | `2GB` | Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size` | -| `region_engine.mito.sst_meta_cache_size` | String | `128MB` | Cache size for SST metadata. Setting it to 0 to disable the cache.
If not set, it's default to 1/32 of OS memory with a max limitation of 128MB. | +| `region_engine.mito.global_write_buffer_size` | String | `None` | Global write buffer size for all regions. If not set, it's default to 1/8 of OS memory with a max limitation of 1GB. | +| `region_engine.mito.global_write_buffer_reject_size` | String | `None` | Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size`. | +| `region_engine.mito.sst_meta_cache_size` | String | `None` | Cache size for SST metadata. Setting it to 0 to disable the cache.
If not set, it's default to 1/32 of OS memory with a max limitation of 128MB. | | `region_engine.mito.vector_cache_size` | String | `512MB` | Cache size for vectors and arrow arrays. Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | | `region_engine.mito.page_cache_size` | String | `512MB` | Cache size for pages of SST row groups. Setting it to 0 to disable the cache.
If not set, it's default to 1/8 of OS memory. | -| `region_engine.mito.selector_result_cache_size` | String | `512MB` | Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | +| `region_engine.mito.selector_result_cache_size` | String | `None` | Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | | `region_engine.mito.enable_experimental_write_cache` | Bool | `false` | Whether to enable the experimental write cache. | | `region_engine.mito.experimental_write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}/write_cache`. | | `region_engine.mito.experimental_write_cache_size` | String | `512MB` | Capacity for write cache. | @@ -165,7 +165,7 @@ | `export_metrics` | -- | -- | The datanode can export its metrics and send to Prometheus compatible service (e.g. send to `greptimedb` itself) from remote-write API.
This is only used for `greptimedb` to export its own metrics internally. It's different from prometheus scrape. | | `export_metrics.enable` | Bool | `false` | whether enable export metrics. | | `export_metrics.write_interval` | String | `30s` | The interval of export metrics. | -| `export_metrics.self_import` | -- | -- | For `standalone` mode, `self_import` is recommend to collect metrics generated by itself
You must create the database before enabling it. | +| `export_metrics.self_import` | -- | -- | For `standalone` mode, `self_import` is recommended to collect metrics generated by itself
You must create the database before enabling it. | | `export_metrics.self_import.db` | String | `None` | -- | | `export_metrics.remote_write` | -- | -- | -- | | `export_metrics.remote_write.url` | String | `""` | The url the metrics send to. The url example can be: `http://127.0.0.1:4000/v1/prometheus/write?db=greptime_metrics`. | @@ -420,12 +420,12 @@ | `region_engine.mito.compress_manifest` | Bool | `false` | Whether to compress manifest and checkpoint file by gzip (default false). | | `region_engine.mito.max_background_jobs` | Integer | `4` | Max number of running background jobs | | `region_engine.mito.auto_flush_interval` | String | `1h` | Interval to auto flush a region if it has not flushed yet. | -| `region_engine.mito.global_write_buffer_size` | String | `1GB` | Global write buffer size for all regions. If not set, it's default to 1/8 of OS memory with a max limitation of 1GB. | -| `region_engine.mito.global_write_buffer_reject_size` | String | `2GB` | Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size` | -| `region_engine.mito.sst_meta_cache_size` | String | `128MB` | Cache size for SST metadata. Setting it to 0 to disable the cache.
If not set, it's default to 1/32 of OS memory with a max limitation of 128MB. | -| `region_engine.mito.vector_cache_size` | String | `512MB` | Cache size for vectors and arrow arrays. Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | -| `region_engine.mito.page_cache_size` | String | `512MB` | Cache size for pages of SST row groups. Setting it to 0 to disable the cache.
If not set, it's default to 1/8 of OS memory. | -| `region_engine.mito.selector_result_cache_size` | String | `512MB` | Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | +| `region_engine.mito.global_write_buffer_size` | String | `None` | Global write buffer size for all regions. If not set, it's default to 1/8 of OS memory with a max limitation of 1GB. | +| `region_engine.mito.global_write_buffer_reject_size` | String | `None` | Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size` | +| `region_engine.mito.sst_meta_cache_size` | String | `None` | Cache size for SST metadata. Setting it to 0 to disable the cache.
If not set, it's default to 1/32 of OS memory with a max limitation of 128MB. | +| `region_engine.mito.vector_cache_size` | String | `None` | Cache size for vectors and arrow arrays. Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | +| `region_engine.mito.page_cache_size` | String | `None` | Cache size for pages of SST row groups. Setting it to 0 to disable the cache.
If not set, it's default to 1/8 of OS memory. | +| `region_engine.mito.selector_result_cache_size` | String | `None` | Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | | `region_engine.mito.enable_experimental_write_cache` | Bool | `false` | Whether to enable the experimental write cache. | | `region_engine.mito.experimental_write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}/write_cache`. | | `region_engine.mito.experimental_write_cache_size` | String | `512MB` | Capacity for write cache. | diff --git a/config/datanode.example.toml b/config/datanode.example.toml index 14fbf914e7ee..ea63c00dcd99 100644 --- a/config/datanode.example.toml +++ b/config/datanode.example.toml @@ -2,7 +2,7 @@ mode = "standalone" ## The datanode identifier and should be unique in the cluster. -## +toml2docs:none-default +## @toml2docs:none-default node_id = 42 ## Start services after regions have obtained leases. @@ -20,23 +20,23 @@ enable_telemetry = true init_regions_parallelism = 16 ## Deprecated, use `grpc.addr` instead. -## +toml2docs:none-default +## @toml2docs:none-default rpc_addr = "127.0.0.1:3001" ## Deprecated, use `grpc.hostname` instead. -## +toml2docs:none-default +## @toml2docs:none-default rpc_hostname = "127.0.0.1" ## Deprecated, use `grpc.runtime_size` instead. -## +toml2docs:none-default +## @toml2docs:none-default rpc_runtime_size = 8 ## Deprecated, use `grpc.rpc_max_recv_message_size` instead. -## +toml2docs:none-default +## @toml2docs:none-default rpc_max_recv_message_size = "512MB" ## Deprecated, use `grpc.rpc_max_send_message_size` instead. -## +toml2docs:none-default +## @toml2docs:none-default rpc_max_send_message_size = "512MB" @@ -71,11 +71,11 @@ max_send_message_size = "512MB" mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload. @@ -135,7 +135,7 @@ provider = "raft_engine" ## The directory to store the WAL files. ## **It's only used when the provider is `raft_engine`**. -## +toml2docs:none-default +## @toml2docs:none-default dir = "/tmp/greptimedb/wal" ## The size of the WAL segment file. @@ -282,83 +282,83 @@ type = "File" ## Cache configuration for object storage such as 'S3' etc. ## The local file cache directory. -## +toml2docs:none-default +## @toml2docs:none-default cache_path = "/path/local_cache" ## The local file cache capacity in bytes. -## +toml2docs:none-default +## @toml2docs:none-default cache_capacity = "256MB" ## The S3 bucket name. ## **It's only used when the storage type is `S3`, `Oss` and `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default bucket = "greptimedb" ## The S3 data will be stored in the specified prefix, for example, `s3://${bucket}/${root}`. ## **It's only used when the storage type is `S3`, `Oss` and `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default root = "greptimedb" ## The access key id of the aws account. ## It's **highly recommended** to use AWS IAM roles instead of hardcoding the access key id and secret key. ## **It's only used when the storage type is `S3` and `Oss`**. -## +toml2docs:none-default +## @toml2docs:none-default access_key_id = "test" ## The secret access key of the aws account. ## It's **highly recommended** to use AWS IAM roles instead of hardcoding the access key id and secret key. ## **It's only used when the storage type is `S3`**. -## +toml2docs:none-default +## @toml2docs:none-default secret_access_key = "test" ## The secret access key of the aliyun account. ## **It's only used when the storage type is `Oss`**. -## +toml2docs:none-default +## @toml2docs:none-default access_key_secret = "test" ## The account key of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default account_name = "test" ## The account key of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default account_key = "test" ## The scope of the google cloud storage. ## **It's only used when the storage type is `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default scope = "test" ## The credential path of the google cloud storage. ## **It's only used when the storage type is `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default credential_path = "test" ## The credential of the google cloud storage. ## **It's only used when the storage type is `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default credential = "base64-credential" ## The container of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default container = "greptimedb" ## The sas token of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default sas_token = "" ## The endpoint of the S3 service. ## **It's only used when the storage type is `S3`, `Oss`, `Gcs` and `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default endpoint = "https://s3.amazonaws.com" ## The region of the S3 service. ## **It's only used when the storage type is `S3`, `Oss`, `Gcs` and `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default region = "us-west-2" # Custom storage options @@ -409,26 +409,32 @@ max_background_jobs = 4 auto_flush_interval = "1h" ## Global write buffer size for all regions. If not set, it's default to 1/8 of OS memory with a max limitation of 1GB. -global_write_buffer_size = "1GB" +## @toml2docs:none-default +#+ global_write_buffer_size = "1GB" ## Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size` -global_write_buffer_reject_size = "2GB" +## @toml2docs:none-default +#+ global_write_buffer_reject_size = "2GB" ## Cache size for SST metadata. Setting it to 0 to disable the cache. ## If not set, it's default to 1/32 of OS memory with a max limitation of 128MB. -sst_meta_cache_size = "128MB" +## @toml2docs:none-default +#+ sst_meta_cache_size = "128MB" ## Cache size for vectors and arrow arrays. Setting it to 0 to disable the cache. ## If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. -vector_cache_size = "512MB" +## @toml2docs:none-default +#+ vector_cache_size = "512MB" ## Cache size for pages of SST row groups. Setting it to 0 to disable the cache. ## If not set, it's default to 1/8 of OS memory. -page_cache_size = "512MB" +## @toml2docs:none-default +#+ page_cache_size = "512MB" ## Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache. ## If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. -selector_result_cache_size = "512MB" +## @toml2docs:none-default +#+ selector_result_cache_size = "512MB" ## Whether to enable the experimental write cache. enable_experimental_write_cache = false @@ -440,7 +446,7 @@ experimental_write_cache_path = "" experimental_write_cache_size = "512MB" ## TTL for write cache. -## +toml2docs:none-default +## @toml2docs:none-default experimental_write_cache_ttl = "8h" ## Buffer size for SST writing. @@ -556,7 +562,7 @@ fork_dictionary_bytes = "1GiB" dir = "/tmp/greptimedb/logs" ## The log level. Can be `info`/`debug`/`warn`/`error`. -## +toml2docs:none-default +## @toml2docs:none-default level = "info" ## Enable OTLP tracing. @@ -590,7 +596,7 @@ write_interval = "30s" ## For `standalone` mode, `self_import` is recommend to collect metrics generated by itself ## You must create the database before enabling it. [export_metrics.self_import] -## +toml2docs:none-default +## @toml2docs:none-default db = "greptime_metrics" [export_metrics.remote_write] @@ -603,5 +609,5 @@ headers = { } ## The tracing options. Only effect when compiled with `tokio-console` feature. [tracing] ## The tokio console address. -## +toml2docs:none-default +## @toml2docs:none-default tokio_console_addr = "127.0.0.1" diff --git a/config/flownode.example.toml b/config/flownode.example.toml index d5640062f701..a3a414fb987d 100644 --- a/config/flownode.example.toml +++ b/config/flownode.example.toml @@ -2,7 +2,7 @@ mode = "distributed" ## The flownode identifier and should be unique in the cluster. -## +toml2docs:none-default +## @toml2docs:none-default node_id = 14 ## The gRPC server options. @@ -63,7 +63,7 @@ retry_interval = "3s" dir = "/tmp/greptimedb/logs" ## The log level. Can be `info`/`debug`/`warn`/`error`. -## +toml2docs:none-default +## @toml2docs:none-default level = "info" ## Enable OTLP tracing. @@ -87,6 +87,6 @@ default_ratio = 1.0 ## The tracing options. Only effect when compiled with `tokio-console` feature. [tracing] ## The tokio console address. -## +toml2docs:none-default +## @toml2docs:none-default tokio_console_addr = "127.0.0.1" diff --git a/config/frontend.example.toml b/config/frontend.example.toml index e5a7f5af898d..855535aa9e12 100644 --- a/config/frontend.example.toml +++ b/config/frontend.example.toml @@ -1,5 +1,5 @@ ## The default timezone of the server. -## +toml2docs:none-default +## @toml2docs:none-default default_timezone = "UTC" ## The runtime options. @@ -44,11 +44,11 @@ runtime_size = 8 mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload. @@ -76,11 +76,11 @@ runtime_size = 2 mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload @@ -101,11 +101,11 @@ runtime_size = 2 mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload @@ -170,7 +170,7 @@ tcp_nodelay = true dir = "/tmp/greptimedb/logs" ## The log level. Can be `info`/`debug`/`warn`/`error`. -## +toml2docs:none-default +## @toml2docs:none-default level = "info" ## Enable OTLP tracing. @@ -204,7 +204,7 @@ write_interval = "30s" ## For `standalone` mode, `self_import` is recommend to collect metrics generated by itself ## You must create the database before enabling it. [export_metrics.self_import] -## +toml2docs:none-default +## @toml2docs:none-default db = "greptime_metrics" [export_metrics.remote_write] @@ -217,5 +217,5 @@ headers = { } ## The tracing options. Only effect when compiled with `tokio-console` feature. [tracing] ## The tokio console address. -## +toml2docs:none-default +## @toml2docs:none-default tokio_console_addr = "127.0.0.1" diff --git a/config/metasrv.example.toml b/config/metasrv.example.toml index dc5f09116646..f9466fb239ea 100644 --- a/config/metasrv.example.toml +++ b/config/metasrv.example.toml @@ -157,7 +157,7 @@ backoff_deadline = "5mins" dir = "/tmp/greptimedb/logs" ## The log level. Can be `info`/`debug`/`warn`/`error`. -## +toml2docs:none-default +## @toml2docs:none-default level = "info" ## Enable OTLP tracing. @@ -191,7 +191,7 @@ write_interval = "30s" ## For `standalone` mode, `self_import` is recommend to collect metrics generated by itself ## You must create the database before enabling it. [export_metrics.self_import] -## +toml2docs:none-default +## @toml2docs:none-default db = "greptime_metrics" [export_metrics.remote_write] @@ -204,5 +204,5 @@ headers = { } ## The tracing options. Only effect when compiled with `tokio-console` feature. [tracing] ## The tokio console address. -## +toml2docs:none-default +## @toml2docs:none-default tokio_console_addr = "127.0.0.1" diff --git a/config/standalone.example.toml b/config/standalone.example.toml index f7c7b2af2964..e86c9cf97d10 100644 --- a/config/standalone.example.toml +++ b/config/standalone.example.toml @@ -5,7 +5,7 @@ mode = "standalone" enable_telemetry = true ## The default timezone of the server. -## +toml2docs:none-default +## @toml2docs:none-default default_timezone = "UTC" ## Initialize all regions in the background during the startup. @@ -46,11 +46,11 @@ runtime_size = 8 mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload. @@ -78,11 +78,11 @@ runtime_size = 2 mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload @@ -103,11 +103,11 @@ runtime_size = 2 mode = "disable" ## Certificate file path. -## +toml2docs:none-default +## @toml2docs:none-default cert_path = "" ## Private key file path. -## +toml2docs:none-default +## @toml2docs:none-default key_path = "" ## Watch for Certificate and key file change and auto reload @@ -139,7 +139,7 @@ provider = "raft_engine" ## The directory to store the WAL files. ## **It's only used when the provider is `raft_engine`**. -## +toml2docs:none-default +## @toml2docs:none-default dir = "/tmp/greptimedb/wal" ## The size of the WAL segment file. @@ -320,83 +320,83 @@ type = "File" ## Cache configuration for object storage such as 'S3' etc. ## The local file cache directory. -## +toml2docs:none-default +## @toml2docs:none-default cache_path = "/path/local_cache" ## The local file cache capacity in bytes. -## +toml2docs:none-default +## @toml2docs:none-default cache_capacity = "256MB" ## The S3 bucket name. ## **It's only used when the storage type is `S3`, `Oss` and `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default bucket = "greptimedb" ## The S3 data will be stored in the specified prefix, for example, `s3://${bucket}/${root}`. ## **It's only used when the storage type is `S3`, `Oss` and `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default root = "greptimedb" ## The access key id of the aws account. ## It's **highly recommended** to use AWS IAM roles instead of hardcoding the access key id and secret key. ## **It's only used when the storage type is `S3` and `Oss`**. -## +toml2docs:none-default +## @toml2docs:none-default access_key_id = "test" ## The secret access key of the aws account. ## It's **highly recommended** to use AWS IAM roles instead of hardcoding the access key id and secret key. ## **It's only used when the storage type is `S3`**. -## +toml2docs:none-default +## @toml2docs:none-default secret_access_key = "test" ## The secret access key of the aliyun account. ## **It's only used when the storage type is `Oss`**. -## +toml2docs:none-default +## @toml2docs:none-default access_key_secret = "test" ## The account key of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default account_name = "test" ## The account key of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default account_key = "test" ## The scope of the google cloud storage. ## **It's only used when the storage type is `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default scope = "test" ## The credential path of the google cloud storage. ## **It's only used when the storage type is `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default credential_path = "test" ## The credential of the google cloud storage. ## **It's only used when the storage type is `Gcs`**. -## +toml2docs:none-default +## @toml2docs:none-default credential = "base64-credential" ## The container of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default container = "greptimedb" ## The sas token of the azure account. ## **It's only used when the storage type is `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default sas_token = "" ## The endpoint of the S3 service. ## **It's only used when the storage type is `S3`, `Oss`, `Gcs` and `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default endpoint = "https://s3.amazonaws.com" ## The region of the S3 service. ## **It's only used when the storage type is `S3`, `Oss`, `Gcs` and `Azblob`**. -## +toml2docs:none-default +## @toml2docs:none-default region = "us-west-2" # Custom storage options @@ -447,26 +447,30 @@ max_background_jobs = 4 auto_flush_interval = "1h" ## Global write buffer size for all regions. If not set, it's default to 1/8 of OS memory with a max limitation of 1GB. -global_write_buffer_size = "1GB" +## @toml2docs:none-default +#+ global_write_buffer_size = "1GB" -## Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size` -global_write_buffer_reject_size = "2GB" +## Global write buffer size threshold to reject write requests. If not set, it's default to 2 times of `global_write_buffer_size`. +## @toml2docs:none-default +#+ global_write_buffer_reject_size = "2GB" ## Cache size for SST metadata. Setting it to 0 to disable the cache. ## If not set, it's default to 1/32 of OS memory with a max limitation of 128MB. -sst_meta_cache_size = "128MB" +## @toml2docs:none-default +#+ sst_meta_cache_size = "128MB" ## Cache size for vectors and arrow arrays. Setting it to 0 to disable the cache. ## If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. -vector_cache_size = "512MB" +#+ vector_cache_size = "512MB" ## Cache size for pages of SST row groups. Setting it to 0 to disable the cache. ## If not set, it's default to 1/8 of OS memory. -page_cache_size = "512MB" +#+ page_cache_size = "512MB" ## Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache. ## If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. -selector_result_cache_size = "512MB" +## @toml2docs:none-default +#+ selector_result_cache_size = "512MB" ## Whether to enable the experimental write cache. enable_experimental_write_cache = false @@ -478,7 +482,7 @@ experimental_write_cache_path = "" experimental_write_cache_size = "512MB" ## TTL for write cache. -## +toml2docs:none-default +## @toml2docs:none-default experimental_write_cache_ttl = "8h" ## Buffer size for SST writing. @@ -600,7 +604,7 @@ fork_dictionary_bytes = "1GiB" dir = "/tmp/greptimedb/logs" ## The log level. Can be `info`/`debug`/`warn`/`error`. -## +toml2docs:none-default +## @toml2docs:none-default level = "info" ## Enable OTLP tracing. @@ -631,10 +635,10 @@ enable = false ## The interval of export metrics. write_interval = "30s" -## For `standalone` mode, `self_import` is recommend to collect metrics generated by itself +## For `standalone` mode, `self_import` is recommended to collect metrics generated by itself ## You must create the database before enabling it. [export_metrics.self_import] -## +toml2docs:none-default +## @toml2docs:none-default db = "greptime_metrics" [export_metrics.remote_write] @@ -647,5 +651,5 @@ headers = { } ## The tracing options. Only effect when compiled with `tokio-console` feature. [tracing] ## The tokio console address. -## +toml2docs:none-default +## @toml2docs:none-default tokio_console_addr = "127.0.0.1"