Unverified Commit 2c676ead authored by 吴晟's avatar 吴晟 Committed by GitHub
Browse files

Add OAP configuration vocabulary documentation. (#5149)

parent 1877d0fc

docs/README.md

+1 −0
Original line number Diff line number Diff line
@@ -70,6 +70,7 @@ If you are already familiar with SkyWalking, you could use this catalog to find 
    * Use [ALS (access log service)](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/accesslog/v2/als.proto) to observe service mesh, without Mixer. Follow [document](en/setup/envoy/als_setting.md) to open it.

  * [Backend, UI and CLI setup document](en/setup/backend/backend-ui-setup.md).

    * [Backend setup document](en/setup/backend/backend-setup.md).

      * [Configuration Vocabulary](en/setup/backend/configuration-vocabulary.md). Configuration Vocabulary lists all available configurations provided by `application.yml`.

      * [Overriding settings](en/setup/backend/backend-setting-override.md) in application.yml is supported.

      * [IP and port setting](en/setup/backend/backend-ip-port.md). Introduces how IP and port set can be used.

      * [Backend init mode startup](en/setup/backend/backend-init-mode.md). How to init the environment and exit graciously. Read this before you try to start a new cluster.

docs/en/setup/backend/backend-setup.md

+3 −0
Original line number Diff line number Diff line
@@ -68,6 +68,9 @@ service by some network(RPC) protocol, such as gRPC, HTTPRestful. 
The receivers have many different module names, you could

read **Set receivers** document in the [link list](#advanced-feature-document-link-list).



## Configuration Vocabulary

All available configurations in `application.yml` could be found in [Configuration Vocabulary](configuration-vocabulary.md). 



## Advanced feature document link list

After understand the setting file structure, you could choose your interesting feature document.

We recommend you to read the feature documents in our following order.

docs/en/setup/backend/backend-storage.md

+6 −12
Original line number Diff line number Diff line
@@ -51,13 +51,14 @@ storage: 
    nameSpace: ${SW_NAMESPACE:""}

    clusterNodes: ${SW_STORAGE_ES_CLUSTER_NODES:localhost:9200}

    protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"http"}

    trustStorePath: ${SW_SW_STORAGE_ES_SSL_JKS_PATH:""}

    trustStorePass: ${SW_SW_STORAGE_ES_SSL_JKS_PASS:""}

    trustStorePath: ${SW_STORAGE_ES_SSL_JKS_PATH:""}

    trustStorePass: ${SW_STORAGE_ES_SSL_JKS_PASS:""}

    dayStep: ${SW_STORAGE_DAY_STEP:1} # Represent the number of days in the one minute/hour/day index.

    user: ${SW_ES_USER:""}

    password: ${SW_ES_PASSWORD:""}

    secretsManagementFile: ${SW_ES_SECRETS_MANAGEMENT_FILE:""} # Secrets management file in the properties format includes the username, password, which are managed by 3rd party tool.

    dayStep: ${SW_STORAGE_DAY_STEP:1} # Represent the number of days in the one minute/hour/day index.

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:1} # Shard number of new indexes

    superDatasetIndexShardsFactor: ${SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR:5} # Super data set has been defined in the codes, such as trace segments. This factor provides more shards for the super data set, shards number = indexShardsNumber * superDatasetIndexShardsFactor. Also, this factor effects Zipkin and Jaeger traces.

    indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}

    # Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html

    bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:1000} # Execute the bulk every 1000 requests
@@ -88,14 +89,7 @@ storage: 
    trustStorePath: ${SW_SW_STORAGE_ES_SSL_JKS_PATH:"../es_keystore.jks"}

    trustStorePass: ${SW_SW_STORAGE_ES_SSL_JKS_PASS:""}

    protocol: ${SW_STORAGE_ES_HTTP_PROTOCOL:"https"}

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:2}

    indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}

    # Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html

    bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:2000} # Execute the bulk every 2000 requests

    bulkSize: ${SW_STORAGE_ES_BULK_SIZE:20} # flush the bulk every 20mb

    flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests

    concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests

    advanced: ${SW_STORAGE_ES_ADVANCED:""}

    ...

```

- File at `trustStorePath` is being monitored, once it is changed, the ElasticSearch client will do reconnecting.

- `trustStorePass` could be changed on the runtime through [**Secrets Management File Of ElasticSearch Authentication**](#secrets-management-file-of-elasticsearch-authentication).

docs/en/setup/backend/configuration-vocabulary.md

0 → 100644
+210 −0

File added.

Preview size limit exceeded, changes collapsed.

oap-server/server-bootstrap/src/main/resources/application.yml

+4 −9
Original line number Diff line number Diff line
@@ -66,13 +66,12 @@ core: 
    downsampling:

      - Hour

      - Day

      - Month

    # Set a timeout on metrics data. After the timeout has expired, the metrics data will automatically be deleted.

    enableDataKeeperExecutor: ${SW_CORE_ENABLE_DATA_KEEPER_EXECUTOR:true} # Turn it off then automatically metrics data delete will be close.

    dataKeeperExecutePeriod: ${SW_CORE_DATA_KEEPER_EXECUTE_PERIOD:5} # How often the data keeper executor runs periodically, unit is minute

    recordDataTTL: ${SW_CORE_RECORD_DATA_TTL:3} # Unit is day

    metricsDataTTL: ${SW_CORE_METRICS_DATA_TTL:7} # Unit is day

    # Cache metric data for 1 minute to reduce database queries, and if the OAP cluster changes within that minute,

    # Cache metrics data for 1 minute to reduce database queries, and if the OAP cluster changes within that minute,

    # the metrics may not be accurate within that minute.

    enableDatabaseSession: ${SW_CORE_ENABLE_DATABASE_SESSION:true}

    topNReportPeriod: ${SW_CORE_TOPN_REPORT_PERIOD:10} # top_n record worker report cycle, unit is minute
@@ -97,10 +96,9 @@ storage: 
    password: ${SW_ES_PASSWORD:""}

    secretsManagementFile: ${SW_ES_SECRETS_MANAGEMENT_FILE:""} # Secrets management file in the properties format includes the username, password, which are managed by 3rd party tool.

    dayStep: ${SW_STORAGE_DAY_STEP:1} # Represent the number of days in the one minute/hour/day index.

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:1} # The index shards number is for store metrics data rather than basic segment record

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:1} # Shard number of new indexes

    superDatasetIndexShardsFactor: ${SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR:5} # Super data set has been defined in the codes, such as trace segments. This factor provides more shards for the super data set, shards number = indexShardsNumber * superDatasetIndexShardsFactor. Also, this factor effects Zipkin and Jaeger traces.

    indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}

    # Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html

    bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:1000} # Execute the bulk every 1000 requests

    flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests

    concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
@@ -119,10 +117,9 @@ storage: 
    user: ${SW_ES_USER:""}

    password: ${SW_ES_PASSWORD:""}

    secretsManagementFile: ${SW_ES_SECRETS_MANAGEMENT_FILE:""} # Secrets management file in the properties format includes the username, password, which are managed by 3rd party tool.

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:1} # The index shards number is for store metrics data rather than basic segment record

    indexShardsNumber: ${SW_STORAGE_ES_INDEX_SHARDS_NUMBER:1} # Shard number of new indexes

    superDatasetIndexShardsFactor: ${SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR:5} # Super data set has been defined in the codes, such as trace segments. This factor provides more shards for the super data set, shards number = indexShardsNumber * superDatasetIndexShardsFactor. Also, this factor effects Zipkin and Jaeger traces.

    indexReplicasNumber: ${SW_STORAGE_ES_INDEX_REPLICAS_NUMBER:0}

    # Batch process setting, refer to https://www.elastic.co/guide/en/elasticsearch/client/java-api/5.5/java-docs-bulk-processor.html

    bulkActions: ${SW_STORAGE_ES_BULK_ACTIONS:1000} # Execute the bulk every 1000 requests

    flushInterval: ${SW_STORAGE_ES_FLUSH_INTERVAL:10} # flush the bulk every 10 seconds whatever the number of requests

    concurrentRequests: ${SW_STORAGE_ES_CONCURRENT_REQUESTS:2} # the number of concurrent requests
@@ -266,7 +263,7 @@ configuration: 
    # Consul host and ports, separated by comma, e.g. 1.2.3.4:8500,2.3.4.5:8500

    hostAndPorts: ${SW_CONFIG_CONSUL_HOST_AND_PORTS:1.2.3.4:8500}

    # Sync period in seconds. Defaults to 60 seconds.

    period: ${SW_CONFIG_CONSUL_PERIOD:1}

    period: ${SW_CONFIG_CONSUL_PERIOD:60}

    # Consul aclToken

    aclToken: ${SW_CONFIG_CONSUL_ACL_TOKEN:""}

  k8s-configmap:
@@ -284,8 +281,6 @@ configuration: 
    namespace: ${SW_CONFIG_NACOS_SERVER_NAMESPACE:}

    # Unit seconds, sync period. Default fetch every 60 seconds.

    period: ${SW_CONFIG_NACOS_PERIOD:60}

    # the name of current cluster, set the name if you want to upstream system known.

    clusterName: ${SW_CONFIG_NACOS_CLUSTER_NAME:default}



exporter:

  selector: ${SW_EXPORTER:-}