kazusa
/
skywalking
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update configuration-vocabulary.md for banyandb (#13118)

This commit is contained in:
Wan Kai 2025-03-19 12:41:38 +08:00 committed by GitHub
parent d838277f4b
commit e4c4a296e8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 54 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/en/setup/backend/configuration-vocabulary.md
View File

@ -2,6 +2,10 @@
The Configuration Vocabulary lists all available configurations provided by `application.yml`.
## Main Configuration
The main configuration is provided by `application.yml`.
It divided into several modules, each of which has its own settings. The following table lists the modules and their settings.
| Module | Provider | Settings | Value(s) and Explanation | System Environment Variable¹ | Default |
|-------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|----------------------------------------------------------------------------------------------|
| core | default | role | Option values: `Mixed/Receiver/Aggregator`. **Receiver** mode OAP opens the service to the agents, then analyzes and aggregates the results, and forwards the results for distributed aggregation. Aggregator mode OAP receives data from Mixer and Receiver role OAP nodes, and performs 2nd level aggregation. **Mixer** means both Receiver and Aggregator. | SW_CORE_ROLE | Mixed |
@ -135,25 +139,7 @@ The Configuration Vocabulary lists all available configurations provided by `app
| - | - | metadataQueryMaxSize | The maximum size of metadata per query. | SW_STORAGE_MYSQL_QUERY_MAX_SIZE | 5000 |
| - | - | maxSizeOfBatchSql | The maximum size of batch size of SQL execution | SW_STORAGE_MAX_SIZE_OF_BATCH_SQL | 2000 |
| - | - | asyncBatchPersistentPoolSize | async flush data into database thread size | SW_STORAGE_ASYNC_BATCH_PERSISTENT_POOL_SIZE | 4 |
| - | banyandb | - | BanyanDB storage. | - | - |
| - | - | 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 |
| - | - | metricsShardsNumber | Shards Number for measure/metrics. | SW_STORAGE_BANYANDB_METRICS_SHARDS_NUMBER | 1 |
| - | - | recordShardsNumber | Shards Number for a normal record. | SW_STORAGE_BANYANDB_RECORD_SHARDS_NUMBER | 1 |
| - | - | superDatasetShardsFactor | Shards Factor for a super dataset record, i.e. Shard number of a super dataset is recordShardsNumber*superDatasetShardsFactor. | SW_STORAGE_BANYANDB_SUPERDATASET_SHARDS_FACTOR | 2 |
| - | - | 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 |
| - | - | segmentIntervalDays | Data is stored in BanyanDB in segments. A segment is a time range of data.The segment interval is the time range of a segment.The value should be less or equal to data TTL relevant settings. | SW_STORAGE_BANYANDB_SEGMENT_INTERVAL_DAYS | 1 |
| - | - | superDatasetSegmentIntervalDays | The super dataset segment interval is the time range of a segment in the super dataset. | SW_STORAGE_BANYANDB_SUPER_DATASET_SEGMENT_INTERVAL_DAYS | 1 |
| - | - | specificGroupSettings | Specific groups settings. | SW_STORAGE_BANYANDB_SPECIFIC_GROUP_SETTINGS | - |
| - | - | 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 | - |
| - | banyandb | - | BanyanDB storage, since 10.2.0, the [banyandb configuration](#banyanDB-configuration ) is separated to an independent configuration file: `bydb.yaml`. | - | - |
| agent-analyzer | default | Agent Analyzer. | SW_AGENT_ANALYZER | default | |
| - | - | traceSamplingPolicySettingsFile | The sampling policy including `sampling rate` and `the threshold of trace segment latency` can be configured by the `traceSamplingPolicySettingsFile` file. | SW_TRACE_SAMPLING_POLICY_SETTINGS_FILE | `trace-sampling-policy-settings.yml` |
| - | - | slowDBAccessThreshold | The slow database access threshold (in milliseconds). | SW_SLOW_DB_THRESHOLD | default:200,mongodb:100 |
@ -363,7 +349,53 @@ The Configuration Vocabulary lists all available configurations provided by `app
| - | - | jfrMaxSize | Used to manage the maximum size of the jfr file that can be received, the unit is Byte, default is 30M. | SW_RECEIVER_ASYNC_PROFILER_JFR_MAX_SIZE | 31457280 |
| - | - | memoryParserEnabled | Used to determine whether to receive jfr in memory file or physical file mode. | SW_RECEIVER_ASYNC_PROFILER_MEMORY_PARSER_ENABLED | true |
## Note
## BanyanDB Configuration
¹ System Environment Variable name could be declared and changed in `application.yml`. The names listed here are simply
provided in the default `application.yml` file.
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 |
### Note
¹ System Environment Variable name could be declared and changed in `application.yml/bydb.yaml`. The names listed here are simply
provided in the default `application.yml/bydb.yaml` file.