Copilot commented on code in PR #13684:
URL: https://github.com/apache/skywalking/pull/13684#discussion_r2729929667
##########
docs/en/setup/backend/configuration-vocabulary.md:
##########
@@ -352,24 +352,25 @@ The following table lists the configuration items:
### Global Configuration
The global settings for the whole BanyanDB:
-| Settings | Value(s) and Explanation
| System Environment
Variable¹ | Default |
-|---------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------|-------------------|
-| 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 |
-| user | The username for BanyanDB authentication.
|
SW_STORAGE_BANYANDB_USER | - |
-| password | The password for BanyanDB authentication.
|
SW_STORAGE_BANYANDB_PASSWORD | - |
-| 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 | - |
-| cleanupUnusedTopNRules | Cleanup TopN rules in BanyanDB server that
are not configured in the bydb-topn.yml config. |
SW_STORAGE_BANYANDB_CLEANUP_UNUSED_TOPN_RULES | true |
-| namespace | The namespace in BanyanDB to store the
data of OAP. | SW_NAMESPACE
| default |
+| Settings | Value(s) and Explanation
| System Environment Variable¹
| Default |
+|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|-----------------|
+| 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 |
Review Comment:
The environment variable names in this table for the BanyanDB query limits
(`SW_STORAGE_BANYAND_QUERY_MAX_WINDOW_SIZE`,
`SW_STORAGE_BANYAND_QUERY_MAX_SIZE`, `SW_STORAGE_BANYAND_QUERY_SEGMENT_SIZE`,
`SW_STORAGE_BANYAND_QUERY_PROFILE_DATA_BATCH_SIZE`) use `BANYAND` rather than
`BANYANDB`, which does not match the actual configuration keys used in bydb.yml
(for example, `SW_STORAGE_BANYANDB_QUERY_MAX_WINDOW_SIZE`). This will cause
users to set the wrong environment variables. Please fix the variable names
here to match the real ones used in the configuration file.
```suggestion
| resultWindowMaxSize | The maximum size of dataset when the OAP
loads cache, such as network aliases.
| SW_STORAGE_BANYANDB_QUERY_MAX_WINDOW_SIZE
| 10000 |
| metadataQueryMaxSize | The maximum size of metadata per query.
| SW_STORAGE_BANYANDB_QUERY_MAX_SIZE
| 10000 |
| segmentQueryMaxSize | The maximum size of trace segments per
query.
| SW_STORAGE_BANYANDB_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_BANYANDB_QUERY_PROFILE_DATA_BATCH_SIZE
| 100 |
```
##########
oap-server/server-starter/src/main/resources/bydb.yml:
##########
@@ -54,7 +54,8 @@ global:
# OAP will create BanyanDB Groups using the format of "{namespace}_{group
name}", such as "sw_records".
namespace: ${SW_NAMESPACE:"sw"}
# The compatible server API versions of BanyanDB.
- compatibleServerApiVersions:
${SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS:"0.9"}
+ # The compatible BanyanDB Server version number can get through the [API
versions
mapping](https://skywalking.apache.org/docs/skywalking-banyandb/latest/installation/versions/).
Review Comment:
The sentence "The compatible BanyanDB Server version number can get through
the API versions mapping" is grammatically awkward; for example, "can be found
via" or "can be obtained from" would be clearer. Consider rephrasing this
comment for better readability.
```suggestion
# The compatible BanyanDB Server version number can be found via the [API
versions
mapping](https://skywalking.apache.org/docs/skywalking-banyandb/latest/installation/versions/).
```
##########
docs/en/setup/backend/configuration-vocabulary.md:
##########
@@ -352,24 +352,25 @@ The following table lists the configuration items:
### Global Configuration
The global settings for the whole BanyanDB:
-| Settings | Value(s) and Explanation
| System Environment
Variable¹ | Default |
-|---------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------|-------------------|
-| 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 |
-| user | The username for BanyanDB authentication.
|
SW_STORAGE_BANYANDB_USER | - |
-| password | The password for BanyanDB authentication.
|
SW_STORAGE_BANYANDB_PASSWORD | - |
-| 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 | - |
-| cleanupUnusedTopNRules | Cleanup TopN rules in BanyanDB server that
are not configured in the bydb-topn.yml config. |
SW_STORAGE_BANYANDB_CLEANUP_UNUSED_TOPN_RULES | true |
-| namespace | The namespace in BanyanDB to store the
data of OAP. | SW_NAMESPACE
| default |
+| Settings | Value(s) and Explanation
| System Environment Variable¹
| Default |
+|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|-----------------|
+| 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 |
+| user | The username for BanyanDB authentication.
| SW_STORAGE_BANYANDB_USER
| - |
+| password | The password for BanyanDB authentication.
| SW_STORAGE_BANYANDB_PASSWORD
| - |
+| 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
| - |
+| cleanupUnusedTopNRules | Cleanup TopN rules in BanyanDB server that
are not configured in the bydb-topn.yml config.
| SW_STORAGE_BANYANDB_CLEANUP_UNUSED_TOPN_RULES
| true |
+| namespace | The namespace in BanyanDB to store the
data of OAP.
| SW_NAMESPACE
| default |
+| compatibleServerApiVersions | The compatible server API versions of
BanyanDB. The compatible BanyanDB Server version number can get through the
[API versions
mapping](https://skywalking.apache.org/docs/skywalking-banyandb/latest/installation/versions/).
| SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS
| 0.10 |
Review Comment:
The sentence "The compatible BanyanDB Server version number can get through
the API versions mapping" in this row is grammatically awkward; for example,
"can be found via" or "can be obtained from" would be clearer. Consider
rephrasing it to make the description smoother for readers.
```suggestion
| compatibleServerApiVersions | The compatible server API versions of
BanyanDB. The compatible BanyanDB Server version number can be found via the
[API versions
mapping](https://skywalking.apache.org/docs/skywalking-banyandb/latest/installation/versions/).
| SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS
| 0.10 |
```
##########
docs/en/setup/backend/storages/banyandb.md:
##########
@@ -66,7 +66,8 @@ global:
# OAP will create BanyanDB Groups using the format of "{namespace}_{group
name}", such as "sw_records".
namespace: ${SW_NAMESPACE:"sw"}
# The compatible server API versions of BanyanDB.
- compatibleServerApiVersions:
${SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS:"0.9"}
+ # The compatible BanyanDB Server version number can get through the [API
versions
mapping](https://skywalking.apache.org/docs/skywalking-banyandb/latest/installation/versions/).
Review Comment:
The sentence "The compatible BanyanDB Server version number can get through
the API versions mapping" is grammatically awkward; for example, "can be found
via" or "can be obtained from" would be clearer. Consider rephrasing this
sentence for better readability.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
