kezhenxu94 commented on a change in pull request #5149:
URL: https://github.com/apache/skywalking/pull/5149#discussion_r458754084
##########
File path: docs/en/setup/backend/configuration-vocabulary.md
##########
@@ -0,0 +1,210 @@
+# Configuration Vocabulary
+Configuration Vocabulary lists all available configurations provided by
`application.yml`.
+
+Module | Provider | Settings | Value(s) and Explanation | System Environment
Variable¹ | Default |
+----------- | ---------- | --------- | --------- |--------- |--------- |
+core|default|role|Option values, `Mixed/Receiver/Aggregator`. **Receiver**
mode OAP open the service to the agents, analysis and aggregate the results and
forward the results for distributed aggregation. Aggregator mode OAP receives
data from Mixer and Receiver role OAP nodes, and do 2nd level aggregation.
**Mixer** means being Receiver and Aggregator both.|SW_CORE_ROLE|Mixed|
+| - | - | restHost| Binding IP of restful service. Services include GraphQL
query and HTTP data report|SW_CORE_REST_HOST|0.0.0.0|
+| - | - | restPort | Binding port of restful service | SW_CORE_REST_PORT|12800|
+| - | - | restContextPath| Web context path of restful service|
SW_CORE_REST_CONTEXT_PATH|/|
+| - | - | gRPCHost|Binding IP of gRPC service. Services include gRPC data
report and internal communication among OAP nodes|SW_CORE_GRPC_HOST|0.0.0.0|
+| - | - | gRPCPort| Binding port of gRPC service | SW_CORE_GRPC_PORT|11800|
+| - | - | gRPCSslEnabled| Activate SSL for gRPC service |
SW_CORE_GRPC_SSL_ENABLED|false|
+| - | - | gRPCSslKeyPath| The file path of gRPC SSL key|
SW_CORE_GRPC_SSL_KEY_PATH| - |
+| - | - | gRPCSslCertChainPath| The file path of gRPC SSL cert chain|
SW_CORE_GRPC_SSL_CERT_CHAIN_PATH| - |
+| - | - | gRPCSslTrustedCAPath| The file path of gRPC trusted CA|
SW_CORE_GRPC_SSL_TRUSTED_CA_PATH| - |
+| - | - | downsampling| The activated level of down sampling aggregation | |
Hour,Day|
+| - | - | enableDataKeeperExecutor|Controller of TTL scheduler. Once disabled,
TTL wouldn't work.|SW_CORE_ENABLE_DATA_KEEPER_EXECUTOR|true|
+| - | - | dataKeeperExecutePeriod|The execution period of TTL scheduler, unit
is minute. Execution doesn't mean deleting data. The storage provider could
override this, such as ElasticSearch
storage.|SW_CORE_DATA_KEEPER_EXECUTE_PERIOD|5|
+| - | - | recordDataTTL|The lifecycle of record data. Record data includes
traces, top n sampled records, and logs. Unit is day. Minimal value is
2.|SW_CORE_RECORD_DATA_TTL|3|
+| - | - | metricsDataTTL|The lifecycle of metrics data, including the
metadata. Unit is day. Recommend metricsDataTTL >= recordDataTTL. Minimal value
is 2.| SW_CORE_METRICS_DATA_TTL|7|
+| - | - | enableDatabaseSession|Cache metrics data for 1 minute to reduce
database queries, and if the OAP cluster changes within that
minute.|SW_CORE_ENABLE_DATABASE_SESSION|true|
+| - | - | topNReportPeriod|The execution period of top N sampler, which saves
sampled data into the storage. Unit is minute|SW_CORE_TOPN_REPORT_PERIOD|10|
+| - | - | activeExtraModelColumns|Append the names of entity, such as service
name, into the metrics storage
entities.|SW_CORE_ACTIVE_EXTRA_MODEL_COLUMNS|false|
+| - | - | serviceNameMaxLength| Max length limitation of service
name.|SW_SERVICE_NAME_MAX_LENGTH|70|
+| - | - | instanceNameMaxLength| Max length limitation of service instance
name. The max length of service + instance names should be less than
200.|SW_INSTANCE_NAME_MAX_LENGTH|70|
+| - | - | endpointNameMaxLength| Max length limitation of endpoint name. The
max length of service + endpoint names should be less than
240.|SW_ENDPOINT_NAME_MAX_LENGTH|150|
+| - | - | gRPCThreadPoolSize|Pool size of gRPC server| - | CPU core * 4|
+| - | - | gRPCThreadPoolQueueSize| The queue size of gRPC server| - | 10000|
+| - | - | maxConcurrentCallsPerConnection | The maximum number of concurrent
calls permitted for each incoming connection. Defaults to no limit. | - | - |
+| - | - | maxMessageSize | Sets the maximum message size allowed to be
received on the server. Empty means 4 MiB | - | 4M(based on Netty) |
+| - | - | remoteTimeout |Timeout for cluster internal communication, in
seconds.| - |20|
+| - | - | maxSizeOfNetworkAddressAlias|Max size of network address detected in
the be monitored system.| - | 1_000_000|
+| - | - | maxPageSizeOfQueryProfileSnapshot|The max size in every OAP query
for snapshot analysis| - | 500 |
+| - | - | maxSizeOfAnalyzeProfileSnapshot|The max number of snapshots analyzed
by OAP| - | 12000 |
+|cluster|standalone| - | standalone is not suitable for one node running, no
available configuration.| - | - |
+| - | zookeeper|nameSpace|The namespace, represented by root path, isolates
the configurations in the zookeeper.|SW_NAMESPACE| `/`, root path|
+| - | - | hostPort|hosts and ports of Zookeeper
Cluster|SW_CLUSTER_ZK_HOST_PORT| localhost:2181|
+| - | - | baseSleepTimeMs|The period of Zookeeper client between two retries.
Unit is ms.|SW_CLUSTER_ZK_SLEEP_TIME|1000|
+| - | - | maxRetries| The max retry time of
re-trying.|SW_CLUSTER_ZK_MAX_RETRIES|3|
+| - | - | enableACL| Open ACL by using `schema` and `expression`|enableACL|
false|
Review comment:
```suggestion
| - | - | enableACL| Open ACL by using `schema` and
`expression`|SW_ZK_ENABLE_ACL| false|
```
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
