BanyanDB config: fix property shardNum env name. (#13128)
This commit is contained in:
Wan Kai
GitHub
parent
e820c75560
commit
21ce981141
|
|
@ -354,46 +354,48 @@ It divided into several modules, each of which has its own settings. The followi
|
|||
Since 10.2.0, the banyandb configuration is separated to an independent configuration file: `bydb.yaml`.
|
||||
The following table lists the configuration items:
|
||||
|
||||
| Part | Group | Settings | Value(s) and Explanation | System Environment Variable¹ | Default |
|
||||
|--------|---------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|
|
||||
| global | - | - | The global settings for the whole BanyanDB. | - | - |
|
||||
| - | - | targets | Hosts with ports of the BanyanDB. | SW_STORAGE_BANYANDB_TARGETS | 127.0.0.1:17912 |
|
||||
| - | - | maxBulkSize | The maximum size of write entities in a single batch write call. | SW_STORAGE_BANYANDB_MAX_BULK_SIZE | 10000 |
|
||||
| - | - | flushInterval | Period of flush interval. In the timeunit of seconds. | SW_STORAGE_BANYANDB_FLUSH_INTERVAL | 15 |
|
||||
| - | - | flushTimeout | The timeout seconds of a bulk flush. | SW_STORAGE_BANYANDB_FLUSH_TIMEOUT | 10 |
|
||||
| - | - | concurrentWriteThreads | Concurrent consumer threads for batch writing. | SW_STORAGE_BANYANDB_CONCURRENT_WRITE_THREADS | 15 |
|
||||
| - | - | profileTaskQueryMaxSize | Max size of ProfileTask to be fetched. | SW_STORAGE_BANYANDB_PROFILE_TASK_QUERY_MAX_SIZE | 200 |
|
||||
| - | - | resultWindowMaxSize | The maximum size of dataset when the OAP loads cache, such as network aliases. | SW_STORAGE_BANYAND_QUERY_MAX_WINDOW_SIZE | 10000 |
|
||||
| - | - | metadataQueryMaxSize | The maximum size of metadata per query. | SW_STORAGE_BANYAND_QUERY_MAX_SIZE | 10000 |
|
||||
| - | - | segmentQueryMaxSize | The maximum size of trace segments per query. | SW_STORAGE_BANYAND_QUERY_SEGMENT_SIZE | 200 |
|
||||
| - | - | asyncProfilerTaskQueryMaxSize | Max size of AsyncProfilerTask to be fetched. | SW_STORAGE_BANYANDB_ASYNC_PROFILER_TASK_QUERY_MAX_SIZE | 200 |
|
||||
| - | - | profileDataQueryScrollBatchSize | The batch size of query profiling data. | SW_STORAGE_BANYAND_QUERY_PROFILE_DATA_BATCH_SIZE | 100 |
|
||||
| - | - | sslTrustCAPath | If the BanyanDB server is configured with TLS, config the TLS cert file path and open tls connection. | SW_STORAGE_BANYANDB_SSL_TRUST_CA_PATH | - |
|
||||
| groups | - | - | The settings for each group. | - | - |
|
||||
| - | recordsNormal | - | The group for records not specified in "super". Each dataset will be grouped under a single group named "normal". | - | - |
|
||||
| - | - | shardNum | Shards Number for normal records group. | SW_STORAGE_BANYANDB_GR_NORMAL_SHARD_NUM | 1 |
|
||||
| - | - | segmentInterval | Shards Number for normal records group. | SW_STORAGE_BANYANDB_GR_NORMAL_SI_DAYS | 1 |
|
||||
| - | - | ttl | Shards Number for normal records group. | SW_STORAGE_BANYANDB_GR_NORMAL_TTL_DAYS | 3 |
|
||||
| - | recordsSuper | - | `super` is a special dataset designed to store trace or log data that is too large for normal datasets.Each super dataset will be a separate group in BanyanDB, following the settings defined in the "super" section. | - | - |
|
||||
| - | - | shardNum | Shards Number for super records group. | SW_STORAGE_BANYANDB_GR_SUPER_SHARD_NUM | 2 |
|
||||
| - | - | segmentInterval | Shards Number for super records group. | SW_STORAGE_BANYANDB_GR_SUPER_SI_DAYS | 1 |
|
||||
| - | - | ttl | Shards Number for super records group. | SW_STORAGE_BANYANDB_GR_SUPER_TTL_DAYS | 3 |
|
||||
| - | metricsMin | - | The group for minute granularity metrics group. | - | - |
|
||||
| - | - | shardNum | Shards Number for minute granularity metrics group. | SW_STORAGE_BANYANDB_GM_MINUTE_SHARD_NUM | 2 |
|
||||
| - | - | segmentInterval | Shards Number for minute granularity metrics group. | SW_STORAGE_BANYANDB_GM_MINUTE_SI_DAYS | 1 |
|
||||
| - | - | ttl | Shards Number for minute granularity metrics group. | SW_STORAGE_BANYANDB_GM_MINUTE_TTL_DAYS | 7 |
|
||||
| - | metricsHour | - | The group for hour granularity metrics. | - | - |
|
||||
| - | - | shardNum | Shards Number for hour granularity metrics group. | SW_STORAGE_BANYANDB_GM_HOUR_SHARD_NUM | 1 |
|
||||
| - | - | segmentInterval | Shards Number for hour granularity metrics group. | SW_STORAGE_BANYANDB_GM_HOUR_SI_DAYS | 5 |
|
||||
| - | - | ttl | Shards Number for hour granularity metrics group. | SW_STORAGE_BANYANDB_GM_HOUR_TTL_DAYS | 15 |
|
||||
| - | metricsDay | - | The group for day granularity metrics. | - | - |
|
||||
| - | - | shardNum | Shards Number for day granularity metrics group. | SW_STORAGE_BANYANDB_GM_DAY_SHARD_NUM | 1 |
|
||||
| - | - | segmentInterval | Shards Number for day granularity metrics group. | SW_STORAGE_BANYANDB_GM_DAY_SI_DAYS | 15 |
|
||||
| - | - | ttl | Shards Number for day granularity metrics group. | SW_STORAGE_BANYANDB_GM_DAY_TTL_DAYS | 15 |
|
||||
| - | metadata | - | The `index` group is designed to store metrics that are used for indexing without value columns. Such as `service_traffic`, `network_address_alias`, etc. Since BanyanDB *0.8.0*. | - | - |
|
||||
| - | - | shardNum | Shards Number for metadata `index` group. | SW_STORAGE_BANYANDB_GM_INDEX_SHARD_NUM | 2 |
|
||||
| - | - | segmentInterval | Shards Number for metadata `index` group. | SW_STORAGE_BANYANDB_GM_INDEX_SI_DAYS | 15 |
|
||||
| - | - | ttl | Shards Number for metadata `index` group. | SW_STORAGE_BANYANDB_GM_INDEX_TTL_DAYS | 15 |
|
||||
| Part | Group | Settings | Value(s) and Explanation | System Environment Variable¹ | Default |
|
||||
|--------|---------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|-----------------|
|
||||
| global | - | - | The global settings for the whole BanyanDB. | - | - |
|
||||
| - | - | targets | Hosts with ports of the BanyanDB. | SW_STORAGE_BANYANDB_TARGETS | 127.0.0.1:17912 |
|
||||
| - | - | maxBulkSize | The maximum size of write entities in a single batch write call. | SW_STORAGE_BANYANDB_MAX_BULK_SIZE | 10000 |
|
||||
| - | - | flushInterval | Period of flush interval. In the timeunit of seconds. | SW_STORAGE_BANYANDB_FLUSH_INTERVAL | 15 |
|
||||
| - | - | flushTimeout | The timeout seconds of a bulk flush. | SW_STORAGE_BANYANDB_FLUSH_TIMEOUT | 10 |
|
||||
| - | - | concurrentWriteThreads | Concurrent consumer threads for batch writing. | SW_STORAGE_BANYANDB_CONCURRENT_WRITE_THREADS | 15 |
|
||||
| - | - | profileTaskQueryMaxSize | Max size of ProfileTask to be fetched. | SW_STORAGE_BANYANDB_PROFILE_TASK_QUERY_MAX_SIZE | 200 |
|
||||
| - | - | resultWindowMaxSize | The maximum size of dataset when the OAP loads cache, such as network aliases. | SW_STORAGE_BANYAND_QUERY_MAX_WINDOW_SIZE | 10000 |
|
||||
| - | - | metadataQueryMaxSize | The maximum size of metadata per query. | SW_STORAGE_BANYAND_QUERY_MAX_SIZE | 10000 |
|
||||
| - | - | segmentQueryMaxSize | The maximum size of trace segments per query. | SW_STORAGE_BANYAND_QUERY_SEGMENT_SIZE | 200 |
|
||||
| - | - | asyncProfilerTaskQueryMaxSize | Max size of AsyncProfilerTask to be fetched. | SW_STORAGE_BANYANDB_ASYNC_PROFILER_TASK_QUERY_MAX_SIZE | 200 |
|
||||
| - | - | profileDataQueryScrollBatchSize | The batch size of query profiling data. | SW_STORAGE_BANYAND_QUERY_PROFILE_DATA_BATCH_SIZE | 100 |
|
||||
| - | - | sslTrustCAPath | If the BanyanDB server is configured with TLS, config the TLS cert file path and open tls connection. | SW_STORAGE_BANYANDB_SSL_TRUST_CA_PATH | - |
|
||||
| groups | - | - | The settings for each group. | - | - |
|
||||
| - | recordsNormal | - | The group for records not specified in "super". Each dataset will be grouped under a single group named "normal". | - | - |
|
||||
| - | - | shardNum | Shards Number for normal records group. | SW_STORAGE_BANYANDB_GR_NORMAL_SHARD_NUM | 1 |
|
||||
| - | - | segmentInterval | Shards Number for normal records group. | SW_STORAGE_BANYANDB_GR_NORMAL_SI_DAYS | 1 |
|
||||
| - | - | ttl | Shards Number for normal records group. | SW_STORAGE_BANYANDB_GR_NORMAL_TTL_DAYS | 3 |
|
||||
| - | recordsSuper | - | `super` is a special dataset designed to store trace or log data that is too large for normal datasets.Each super dataset will be a separate group in BanyanDB, following the settings defined in the "super" section.| - | - |
|
||||
| - | - | shardNum | Shards Number for super records group. | SW_STORAGE_BANYANDB_GR_SUPER_SHARD_NUM | 2 |
|
||||
| - | - | segmentInterval | Shards Number for super records group. | SW_STORAGE_BANYANDB_GR_SUPER_SI_DAYS | 1 |
|
||||
| - | - | ttl | Shards Number for super records group. | SW_STORAGE_BANYANDB_GR_SUPER_TTL_DAYS | 3 |
|
||||
| - | metricsMin | - | The group for minute granularity metrics group. | - | - |
|
||||
| - | - | shardNum | Shards Number for minute granularity metrics group. | SW_STORAGE_BANYANDB_GM_MINUTE_SHARD_NUM | 2 |
|
||||
| - | - | segmentInterval | Shards Number for minute granularity metrics group. | SW_STORAGE_BANYANDB_GM_MINUTE_SI_DAYS | 1 |
|
||||
| - | - | ttl | Shards Number for minute granularity metrics group. | SW_STORAGE_BANYANDB_GM_MINUTE_TTL_DAYS | 7 |
|
||||
| - | metricsHour | - | The group for hour granularity metrics. | - | - |
|
||||
| - | - | shardNum | Shards Number for hour granularity metrics group. | SW_STORAGE_BANYANDB_GM_HOUR_SHARD_NUM | 1 |
|
||||
| - | - | segmentInterval | Shards Number for hour granularity metrics group. | SW_STORAGE_BANYANDB_GM_HOUR_SI_DAYS | 5 |
|
||||
| - | - | ttl | Shards Number for hour granularity metrics group. | SW_STORAGE_BANYANDB_GM_HOUR_TTL_DAYS | 15 |
|
||||
| - | metricsDay | - | The group for day granularity metrics. | - | - |
|
||||
| - | - | shardNum | Shards Number for day granularity metrics group. | SW_STORAGE_BANYANDB_GM_DAY_SHARD_NUM | 1 |
|
||||
| - | - | segmentInterval | Shards Number for day granularity metrics group. | SW_STORAGE_BANYANDB_GM_DAY_SI_DAYS | 15 |
|
||||
| - | - | ttl | Shards Number for day granularity metrics group. | SW_STORAGE_BANYANDB_GM_DAY_TTL_DAYS | 15 |
|
||||
| - | metadata | - | The `index` group is designed to store metrics that are used for indexing without value columns. Such as `service_traffic`, `network_address_alias`, etc. Since BanyanDB *0.8.0*. | - | - |
|
||||
| - | - | shardNum | Shards Number for metadata `index` group. | SW_STORAGE_BANYANDB_GM_INDEX_SHARD_NUM | 2 |
|
||||
| - | - | segmentInterval | Shards Number for metadata `index` group. | SW_STORAGE_BANYANDB_GM_INDEX_SI_DAYS | 15 |
|
||||
| - | - | ttl | Shards Number for metadata `index` group. | SW_STORAGE_BANYANDB_GM_INDEX_TTL_DAYS | 15 |
|
||||
| - | property | - | The group settings of property, such as UI and profiling. | - | - |
|
||||
| - | - | shardNum | Shards Number for property group. | SW_STORAGE_BANYANDB_GP_PROPERTY_SHARD_NUM | 1 |
|
||||
|
||||
### Note
|
||||
|
||||
|
|
|
|||
|
|
@ -106,7 +106,9 @@ groups:
|
|||
shardNum: ${SW_STORAGE_BANYANDB_GM_INDEX_SHARD_NUM:2}
|
||||
segmentInterval: ${SW_STORAGE_BANYANDB_GM_INDEX_SI_DAYS:15}
|
||||
ttl: ${SW_STORAGE_BANYANDB_GM_INDEX_TTL_DAYS:15}
|
||||
|
||||
# The group settings of property such as UI and profiling.
|
||||
property:
|
||||
shardNum: ${SW_STORAGE_BANYANDB_GP_PROPERTY_SHARD_NUM:1}
|
||||
```
|
||||
|
||||
### Installation Modes
|
||||
|
|
|
|||
|
|
@ -88,6 +88,6 @@ groups:
|
|||
segmentInterval: ${SW_STORAGE_BANYANDB_GM_INDEX_SI_DAYS:15}
|
||||
ttl: ${SW_STORAGE_BANYANDB_GM_INDEX_TTL_DAYS:15}
|
||||
|
||||
# The group settings of UI and profiling.
|
||||
# The group settings of property, such as UI and profiling.
|
||||
property:
|
||||
shardNum: ${SW_STORAGE_BANYANDB_GM_INDEX_SHARD_NUM:1}
|
||||
shardNum: ${SW_STORAGE_BANYANDB_GP_PROPERTY_SHARD_NUM:1}
|
||||
|
|
|
|||
Loading…
Reference in New Issue