From b7cf846b6950d0ea49cdc3a773db7ed0efaec182 Mon Sep 17 00:00:00 2001 From: farisbasha Date: Wed, 18 Nov 2026 16:11:26 +0530 Subject: [PATCH 1/2] Fix configuration vocabulary rows that disagree with application.yml --- docs/en/changes/changes.md | 1 + .../setup/backend/configuration-vocabulary.md | 31 ++++++++++--------- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index 491f684e1118..b759f9fdb780 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -80,6 +80,7 @@ * Fix the trace sampling doc's setting name, `default.rate`, and its example rates, and document the OpenTelemetry span metadata fallbacks, that metrics shared across TAL rules must also agree on `labelLimit`, and, on the Virtual GenAI page, the `service.layer=OTLP_GENERAL` that the AI evaluation of natively stored OpenTelemetry spans needs. * Clarify in the security notice that every admin-port route, including the status API and the configuration dump, must be reachable only by the operator team, and where the status and debugging routes were served before 11.0.0 (the core REST port, `12800`). Document that the configuration dump masks a value only when its key contains a masking keyword, and which settings, such as Kafka SASL properties and the ZooKeeper ACL `expression`, need extra keywords. * Fix the admin API docs and the `application.yml` comments that said an empty value, such as `SW_STATUS=`, disables an admin module: an empty value stops OAP from starting, and `-` removes the module. Closing the admin port takes `SW_ADMIN_SERVER=-` together with `-` for every admin feature module. +* Fix the configuration vocabulary rows that disagree with `application.yml`: the environment variables of the etcd, k8s-configmap and Nacos `period`, the Nacos `group` (and the missing `namespace` row) and `maxHttpUrisNumberPerService`, the setting names `profileDataQueryBatchSize` and Consul `hostAndPorts`, and the defaults of `indexReplicasNumber`, `checkIntervalSeconds`, `baselineServerPort`, `searchableLogsTags`, `lalFiles`, `malFiles`, the Zipkin query `restContextPath` and the ZooKeeper configuration `namespace`. All issues and pull requests are [here](https://github.com/apache/skywalking/issues?q=milestone:11.2.0) diff --git a/docs/en/setup/backend/configuration-vocabulary.md b/docs/en/setup/backend/configuration-vocabulary.md index c69e25335625..680571cc7629 100644 --- a/docs/en/setup/backend/configuration-vocabulary.md +++ b/docs/en/setup/backend/configuration-vocabulary.md @@ -38,7 +38,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | instanceNameMaxLength | Maximum length limit of service instance names. The maximum length of service + instance names should be less than 200. | SW_INSTANCE_NAME_MAX_LENGTH | 70 | | - | - | endpointNameMaxLength | Maximum length limit of endpoint names. The maximum length of service + endpoint names should be less than 240. | SW_ENDPOINT_NAME_MAX_LENGTH | 150 | | - | - | searchableTracesTags | Defines a set of span tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. | SW_SEARCHABLE_TAG_KEYS | http.method,http.status_code,rpc.status_code,db.type,db.instance,mq.queue,mq.topic,mq.broker | -| - | - | searchableLogsTags | Defines a set of log tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. | SW_SEARCHABLE_LOGS_TAG_KEYS | level | +| - | - | searchableLogsTags | Defines a set of log tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. | SW_SEARCHABLE_LOGS_TAG_KEYS | level,http.status_code,ai_route_type | | - | - | searchableAlarmTags | Defines a set of alarm tag keys which are searchable through GraphQL. Multiple values are separated by commas. The max length of key=value should be less than 256 or will be dropped. | SW_SEARCHABLE_ALARM_TAG_KEYS | level | | - | - | autocompleteTagKeysQueryMaxSize | The max size of tags keys for autocomplete select. | SW_AUTOCOMPLETE_TAG_KEYS_QUERY_MAX_SIZE | 100 | | - | - | autocompleteTagValuesQueryMaxSize | The max size of tags values for autocomplete select. | SW_AUTOCOMPLETE_TAG_VALUES_QUERY_MAX_SIZE | 100 | @@ -100,7 +100,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | secretKey | Nacos Auth secretKey. | SW_CLUSTER_NACOS_SECRETKEY | - | | - | - | syncPeriodHttpUriRecognitionPattern | The period of HTTP URI recognition pattern synchronization (in seconds). | SW_CORE_SYNC_PERIOD_HTTP_URI_RECOGNITION_PATTERN | 10 | | - | - | trainingPeriodHttpUriRecognitionPattern | The period of HTTP URI recognition pattern training (in seconds). | SW_CORE_TRAINING_PERIOD_HTTP_URI_RECOGNITION_PATTERN | 60 | -| - | - | maxHttpUrisNumberPerService | The maximum number of HTTP URIs per service. | SW_MAX_HTTP_URIS_NUMBER_PER_SERVICE | 3000 | | +| - | - | maxHttpUrisNumberPerService | The maximum number of HTTP URIs per service. | SW_CORE_MAX_HTTP_URIS_NUMBER_PER_SVR | 3000 | | | storage | elasticsearch | - | ElasticSearch (and OpenSearch) storage implementation. | - | - | | - | - | namespace | Prefix of indexes created and used by SkyWalking. | SW_NAMESPACE | - | | - | - | clusterNodes | ElasticSearch cluster nodes for client connection. | SW_STORAGE_ES_CLUSTER_NODES | localhost | @@ -116,7 +116,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | secretsManagementFile | Secrets management file in the properties format, including username and password, which are managed by a 3rd party tool. Capable of being updated them at runtime. | SW_ES_SECRETS_MANAGEMENT_FILE | - | | - | - | dayStep | Represents the number of days in the one-minute/hour/day index. | SW_STORAGE_DAY_STEP | 1 | | - | - | indexShardsNumber | Shard number of new indexes. | SW_STORAGE_ES_INDEX_SHARDS_NUMBER | 1 | -| - | - | indexReplicasNumber | Replicas number of new indexes. | SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 0 | +| - | - | indexReplicasNumber | Replicas number of new indexes. | SW_STORAGE_ES_INDEX_REPLICAS_NUMBER | 1 | | - | - | specificIndexSettings | Specify the settings for each index individually. If configured, this setting has the highest priority and overrides the generic settings. | SW_STORAGE_ES_SPECIFIC_INDEX_SETTINGS | - | | - | - | superDatasetDayStep | Represents the number of days in the super size dataset record index. Default value is the same as dayStep when the value is less than 0. | SW_STORAGE_ES_SUPER_DATASET_DAY_STEP | -1 | | - | - | superDatasetIndexShardsFactor | Super dataset is defined in the code (e.g. trace segments). This factor provides more shards for the super dataset: shards number = indexShardsNumber * superDatasetIndexShardsFactor. This factor also affects Zipkin and Jaeger traces. | SW_STORAGE_ES_SUPER_DATASET_INDEX_SHARDS_FACTOR | 5 | @@ -132,7 +132,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | segmentQueryMaxSize | The maximum size of trace segments per query. | SW_STORAGE_ES_QUERY_SEGMENT_SIZE | 200 | | - | - | profileTaskQueryMaxSize | The maximum size of profile task per query. | SW_STORAGE_ES_QUERY_PROFILE_TASK_SIZE | 200 | | - | - | asyncProfilerTaskQueryMaxSize | The maximum size of async-profiler task per query. | SW_STORAGE_ES_QUERY_ASYNC_PROFILER_TASK_SIZE | 200 | -| - | - | profileDataQueryScrollBatchSize | The batch size of query profiling data. | SW_STORAGE_ES_QUERY_PROFILE_DATA_BATCH_SIZE | 100 | +| - | - | profileDataQueryBatchSize | The batch size of query profiling data. | SW_STORAGE_ES_QUERY_PROFILE_DATA_BATCH_SIZE | 100 | | - | - | advanced | All settings of ElasticSearch index creation. The value should be in JSON format. | SW_STORAGE_ES_ADVANCED | - | | - | - | logicSharding | Shard metrics and records indices into multi-physical indices, one index template per metric/meter aggregation function or record. | SW_STORAGE_ES_LOGIC_SHARDING | false | | - | mysql | - | MySQL Storage. The MySQL JDBC Driver is not in the dist. Please copy it into the oap-lib folder manually. | - | - | @@ -175,8 +175,8 @@ It divided into several modules, each of which has its own settings. The followi | - | - | maxMessageSize | Sets the maximum message size allowed to be received on the server. Empty means 4 MiB. | SW_RECEIVER_GRPC_MAX_MESSAGE_SIZE | 52428800 (50MB) | | - | - | authentication | The token text for authentication. Works for gRPC connection only. Once this is set, the client is required to use the same token. | SW_AUTHENTICATION | - | | log-analyzer | default | Log Analyzer. | SW_LOG_ANALYZER | default | | -| - | - | lalFiles | The LAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. | SW_LOG_LAL_FILES | default | -| - | - | malFiles | The MAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. | SW_LOG_MAL_FILES | "" | +| - | - | lalFiles | The LAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. | SW_LOG_LAL_FILES | envoy-als,mesh-dp,mysql-slowsql,pgsql-slowsql,redis-slowsql,k8s-service,nginx,envoy-ai-gateway,miniprogram,ai-agent,default | +| - | - | malFiles | The MAL configuration file names (without file extension) to be activated. Read [LAL](../../concepts-and-designs/lal.md) for more details. | SW_LOG_MAL_FILES | nginx,miniprogram-wechat,miniprogram-alipay | | trace-analyzer | default | Trace Analyzer. | SW_TRACE_ANALYZER | default | | | - | - | nativeTalFiles | The TAL configuration file names for the segments SkyWalking agents send (without file extension), comma separated, in the order their rules run. A listed file that does not exist fails the boot. Read [Native Trace Analysis](native-trace-analysis.md) for more details. | SW_TRACE_NATIVE_TAL_FILES | native-rpc,native-endpoint-cross-thread,native-network-alias,native-segment,native-virtual-service,native-virtual-genai,native-ai-evaluation | | - | - | talFiles | The TAL configuration file names for OTLP spans (without file extension) to be activated, comma separated. Empty disables the OTLP span analysis while keeping the module loaded. Read [TAL for OpenTelemetry Spans](../../concepts-and-designs/tal-otlp.md) for more details. | SW_TRACE_TAL_FILES | otlp-general,otlp-ai-evaluation | @@ -293,7 +293,7 @@ It divided into several modules, each of which has its own settings. The followi | query-zipkin | default | - | This module is for Zipkin query API and support zipkin-lens UI | - | | | - | - | restHost | Binding IP of RESTful services. | SW_QUERY_ZIPKIN_REST_HOST | 0.0.0.0 | | - | - | restPort | Binding port of RESTful services. | SW_QUERY_ZIPKIN_REST_PORT | 9412 | -| - | - | restContextPath | Web context path of RESTful services. | SW_QUERY_ZIPKIN_REST_CONTEXT_PATH | zipkin | +| - | - | restContextPath | Web context path of RESTful services. | SW_QUERY_ZIPKIN_REST_CONTEXT_PATH | /zipkin | | - | - | restIdleTimeOut | Connector idle timeout of RESTful services (in milliseconds). | SW_QUERY_ZIPKIN_REST_IDLE_TIMEOUT | 30000 | | - | - | restAcceptQueueSize | Maximum request header size accepted. | SW_QUERY_ZIPKIN_REST_QUEUE_SIZE | 0 | | - | - | restSSLEnabled | Activates TLS for the Zipkin query HTTP server (reloaded on rotation; server-side TLS only). | SW_QUERY_ZIPKIN_REST_SSL_ENABLED | false | @@ -352,7 +352,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | apolloCluster | `apollo.cluster` in Apollo. | SW_CONFIG_APOLLO_CLUSTER | default | | - | - | apolloEnv | `env` in Apollo. | SW_CONFIG_APOLLO_ENV | - | | - | - | appId | `app.id` in Apollo. | SW_CONFIG_APOLLO_APP_ID | skywalking | -| - | zookeeper | namespace | The namespace (represented by root path) that isolates the configurations in the Zookeeper. | SW_CONFIG_ZK_NAMESPACE | `/`, root path | +| - | zookeeper | namespace | The namespace (represented by root path) that isolates the configurations in the Zookeeper. | SW_CONFIG_ZK_NAMESPACE | /default | | - | - | hostPort | Hosts and ports of Zookeeper Cluster. | SW_CONFIG_ZK_HOST_PORT | localhost:2181 | | - | - | baseSleepTimeMs | The period of Zookeeper client between two retries (in milliseconds). | SW_CONFIG_ZK_BASE_SLEEP_TIME_MS | 1000 | | - | - | maxRetries | The maximum retry time. | SW_CONFIG_ZK_MAX_RETRIES | 3 | @@ -362,17 +362,18 @@ It divided into several modules, each of which has its own settings. The followi | - | - | authentication | Indicates whether there is authentication. | SW_CONFIG_ETCD_AUTHENTICATION | false | | - | - | user | Etcd auth username. | SW_CONFIG_ETCD_USER | | | - | - | password | Etcd auth password. | SW_CONFIG_ETCD_PASSWORD | | -| - | - | period | The period of data sync (in seconds). | SW_CONFIG_ZK_PERIOD | 60 | -| - | consul | hostPort | Hosts and ports for Consul cluster. | SW_CONFIG_CONSUL_HOST_AND_PORTS | localhost:8500 | +| - | - | period | The period of data sync (in seconds). | SW_CONFIG_ETCD_PERIOD | 60 | +| - | consul | hostAndPorts | Hosts and ports for Consul cluster. | SW_CONFIG_CONSUL_HOST_AND_PORTS | localhost:8500 | | - | - | aclToken | ACL Token of Consul. Empty string means `without ACL token`. | SW_CONFIG_CONSUL_ACL_TOKEN | - | | - | - | period | The period of data sync (in seconds). | SW_CONFIG_CONSUL_PERIOD | 60 | | - | k8s-configmap | namespace | Deployment namespace of the config map. | SW_CLUSTER_K8S_NAMESPACE | default | | - | - | labelSelector | Labels for locating configmap. | SW_CLUSTER_K8S_LABEL | app=collector,release=skywalking | -| - | - | period | The period of data sync (in seconds). | SW_CONFIG_ZK_PERIOD | 60 | +| - | - | period | The period of data sync (in seconds). | SW_CONFIG_CONFIGMAP_PERIOD | 60 | | - | nacos | serverAddr | Nacos Server Host. | SW_CONFIG_NACOS_SERVER_ADDR | 127.0.0.1 | | - | - | port | Nacos Server Port. | SW_CONFIG_NACOS_SERVER_PORT | 8848 | -| - | - | group | Nacos Configuration namespace. | SW_CONFIG_NACOS_SERVER_NAMESPACE | - | -| - | - | period | The period of data sync (in seconds). | SW_CONFIG_CONFIG_NACOS_PERIOD | 60 | +| - | - | group | Nacos Configuration group. | SW_CONFIG_NACOS_SERVER_GROUP | skywalking | +| - | - | namespace | Nacos Configuration namespace. | SW_CONFIG_NACOS_SERVER_NAMESPACE | - | +| - | - | period | The period of data sync (in seconds). | SW_CONFIG_NACOS_PERIOD | 60 | | - | - | username | Nacos Auth username. | SW_CONFIG_NACOS_USERNAME | - | | - | - | password | Nacos Auth password. | SW_CONFIG_NACOS_PASSWORD | - | | - | - | accessKey | Nacos Auth accessKey. | SW_CONFIG_NACOS_ACCESSKEY | - | @@ -387,7 +388,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | kafkaTopicTrace | Kafka topic name for trace. | SW_EXPORTER_KAFKA_TOPIC_TRACE | skywalking-export-trace | | - | - | kafkaTopicLog | Kafka topic name for log. | SW_EXPORTER_KAFKA_TOPIC_LOG | skywalking-export-log | | - | - | exportErrorStatusTraceOnly | Export error status trace segments through the Kafka channel. | SW_EXPORTER_KAFKA_TRACE_FILTER_ERROR | false | -| health-checker | default | checkIntervalSeconds | The period of checking OAP internal health status (in seconds). | SW_HEALTH_CHECKER_INTERVAL_SECONDS | 5 | +| health-checker | default | checkIntervalSeconds | The period of checking OAP internal health status (in seconds). | SW_HEALTH_CHECKER_INTERVAL_SECONDS | 30 | | status | default | (selector) | Status feature module — hosts /status/* and /debugging/* routes on the admin-server REST host; `/status/config/ttl` is also served on the query server (`query-server`), next to `/graphql`. Both `status` and `admin-server` are enabled by default; set SW_STATUS to `-` to disable. | SW_STATUS | default | | - | - | keywords4MaskingSecretsOfConfig | Include the list of keywords to filter configurations including secrets. Separate keywords by a comma. | SW_DEBUGGING_QUERY_KEYWORDS_FOR_MASKING_SECRETS | user,password,trustStorePass,keyStorePass,token,accessKey,secretKey,authentication | | inspect | default | (selector) | Inspect API on admin-server — /inspect/metrics (catalog) and /inspect/entities (entity enumeration with MQE-ready output). Routes only on the admin-server register. **Enabled by default** (admin-server is on by default too); set SW_INSPECT to `-` to disable. | SW_INSPECT | default | @@ -433,7 +434,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | uriRecognitionServerAddr | The address of the URI recognition server. | SW_AI_PIPELINE_URI_RECOGNITION_SERVER_ADDR | - | | - | - | uriRecognitionServerPort | The port of the URI recognition server. | SW_AI_PIPELINE_URI_RECOGNITION_SERVER_PORT | 17128 | | - | - | baselineServerAddr | The address of the Baseline server. | SW_API_PIPELINE_BASELINE_SERVICE_HOST | - | -| - | - | baselineServerPort | The port of the Baseline server. | SW_API_PIPELINE_BASELINE_SERVICE_PORT | 17128 | +| - | - | baselineServerPort | The port of the Baseline server. | SW_API_PIPELINE_BASELINE_SERVICE_PORT | 18080 | | receiver-async-profiler | default | gRPC services that accept async-profiler task status and data reporter. | - | - | | | - | - | 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 | From c56c37a1824b011fe46d44af76d02ff9611b3e1a Mon Sep 17 00:00:00 2001 From: farisbasha Date: Wed, 18 Nov 2026 18:07:37 +0530 Subject: [PATCH 2/2] Fix the remaining vocabulary rows found in review --- docs/en/changes/changes.md | 2 +- .../setup/backend/configuration-vocabulary.md | 20 +++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index b759f9fdb780..bca4600dc513 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -80,7 +80,7 @@ * Fix the trace sampling doc's setting name, `default.rate`, and its example rates, and document the OpenTelemetry span metadata fallbacks, that metrics shared across TAL rules must also agree on `labelLimit`, and, on the Virtual GenAI page, the `service.layer=OTLP_GENERAL` that the AI evaluation of natively stored OpenTelemetry spans needs. * Clarify in the security notice that every admin-port route, including the status API and the configuration dump, must be reachable only by the operator team, and where the status and debugging routes were served before 11.0.0 (the core REST port, `12800`). Document that the configuration dump masks a value only when its key contains a masking keyword, and which settings, such as Kafka SASL properties and the ZooKeeper ACL `expression`, need extra keywords. * Fix the admin API docs and the `application.yml` comments that said an empty value, such as `SW_STATUS=`, disables an admin module: an empty value stops OAP from starting, and `-` removes the module. Closing the admin port takes `SW_ADMIN_SERVER=-` together with `-` for every admin feature module. -* Fix the configuration vocabulary rows that disagree with `application.yml`: the environment variables of the etcd, k8s-configmap and Nacos `period`, the Nacos `group` (and the missing `namespace` row) and `maxHttpUrisNumberPerService`, the setting names `profileDataQueryBatchSize` and Consul `hostAndPorts`, and the defaults of `indexReplicasNumber`, `checkIntervalSeconds`, `baselineServerPort`, `searchableLogsTags`, `lalFiles`, `malFiles`, the Zipkin query `restContextPath` and the ZooKeeper configuration `namespace`. +* Fix the configuration vocabulary rows that disagree with `application.yml`: the environment variables of the etcd, k8s-configmap and Nacos `period`, the slow cache read/write thresholds, the Cilium fetcher `sslConnection` and the etcd configuration `password`, the Nacos `group` (and the missing `namespace` row) and `maxHttpUrisNumberPerService`, the setting names `profileDataQueryBatchSize` and Consul `hostAndPorts`, and the defaults of `indexReplicasNumber`, `checkIntervalSeconds`, `baselineServerPort`, `searchableLogsTags`, `lalFiles`, `malFiles`, `meterAnalyzerActiveFiles`, the Zipkin query `restContextPath` and the ZooKeeper configuration `namespace`; move the HTTP URI recognition rows back under `core` and name the `aws-firehose` module correctly. All issues and pull requests are [here](https://github.com/apache/skywalking/issues?q=milestone:11.2.0) diff --git a/docs/en/setup/backend/configuration-vocabulary.md b/docs/en/setup/backend/configuration-vocabulary.md index 680571cc7629..7ca0184ed979 100644 --- a/docs/en/setup/backend/configuration-vocabulary.md +++ b/docs/en/setup/backend/configuration-vocabulary.md @@ -51,6 +51,9 @@ It divided into several modules, each of which has its own settings. The followi | - | - | maxSizeOfAnalyzeProfileSnapshot | The maximum number of snapshots analyzed by the OAP. | - | 12000 | | - | - | prepareThreads | The number of threads used to prepare metrics data to the storage. | SW_CORE_PREPARE_THREADS | 2 | | - | - | enableEndpointNameGroupingByOpenapi | Automatically groups endpoints by the given OpenAPI definitions. | SW_CORE_ENABLE_ENDPOINT_NAME_GROUPING_BY_OPENAPI | true | +| - | - | syncPeriodHttpUriRecognitionPattern | The period of HTTP URI recognition pattern synchronization (in seconds). | SW_CORE_SYNC_PERIOD_HTTP_URI_RECOGNITION_PATTERN | 10 | +| - | - | trainingPeriodHttpUriRecognitionPattern | The period of HTTP URI recognition pattern training (in seconds). | SW_CORE_TRAINING_PERIOD_HTTP_URI_RECOGNITION_PATTERN | 60 | +| - | - | maxHttpUrisNumberPerService | The maximum number of HTTP URIs per service. | SW_CORE_MAX_HTTP_URIS_NUMBER_PER_SVR | 3000 | | | - | - | maxDurationOfQueryEBPFProfilingData | The maximum duration(in second) of query the eBPF profiling data from database. | - | 30 | | - | - | maxThreadCountOfQueryEBPFProfilingData | The maximum thread count of query the eBPF profiling data from database. | - | System CPU core size | | - | - | serviceCacheRefreshInterval | The period(in seconds) of refreshing the service cache. | SW_SERVICE_CACHE_REFRESH_INTERVAL | 10 | @@ -98,9 +101,6 @@ It divided into several modules, each of which has its own settings. The followi | - | - | password | Nacos Auth password. | SW_CLUSTER_NACOS_PASSWORD | - | | - | - | accessKey | Nacos Auth accessKey. | SW_CLUSTER_NACOS_ACCESSKEY | - | | - | - | secretKey | Nacos Auth secretKey. | SW_CLUSTER_NACOS_SECRETKEY | - | -| - | - | syncPeriodHttpUriRecognitionPattern | The period of HTTP URI recognition pattern synchronization (in seconds). | SW_CORE_SYNC_PERIOD_HTTP_URI_RECOGNITION_PATTERN | 10 | -| - | - | trainingPeriodHttpUriRecognitionPattern | The period of HTTP URI recognition pattern training (in seconds). | SW_CORE_TRAINING_PERIOD_HTTP_URI_RECOGNITION_PATTERN | 60 | -| - | - | maxHttpUrisNumberPerService | The maximum number of HTTP URIs per service. | SW_CORE_MAX_HTTP_URIS_NUMBER_PER_SVR | 3000 | | | storage | elasticsearch | - | ElasticSearch (and OpenSearch) storage implementation. | - | - | | - | - | namespace | Prefix of indexes created and used by SkyWalking. | SW_NAMESPACE | - | | - | - | clusterNodes | ElasticSearch cluster nodes for client connection. | SW_STORAGE_ES_CLUSTER_NODES | localhost | @@ -152,9 +152,9 @@ It divided into several modules, each of which has its own settings. The followi | - | - | forceSampleErrorSegment | When sampling mechanism is activated, this config samples the error status segment and ignores the sampling rate. | SW_FORCE_SAMPLE_ERROR_SEGMENT | true | | - | - | segmentStatusAnalysisStrategy | Determines the final segment status from span status. Available values are `FROM_SPAN_STATUS` , `FROM_ENTRY_SPAN`, and `FROM_FIRST_SPAN`. `FROM_SPAN_STATUS` indicates that the segment status would be error if any span has an error status. `FROM_ENTRY_SPAN` means that the segment status would only be determined by the status of entry spans. `FROM_FIRST_SPAN` means that the segment status would only be determined by the status of the first span. | SW_SEGMENT_STATUS_ANALYSIS_STRATEGY | FROM_SPAN_STATUS | | - | - | noUpstreamRealAddressAgents | Exit spans with the component in the list would not generate client-side instance relation metrics, since some tracing plugins (e.g. Nginx-LUA and Envoy) can't collect the real peer IP address. | SW_NO_UPSTREAM_REAL_ADDRESS | 6000,9000 | -| - | - | meterAnalyzerActiveFiles | Indicates which files could be instrumented and analyzed. Multiple files are split by ",". | SW_METER_ANALYZER_ACTIVE_FILES | | | -| - | - | slowCacheWriteThreshold | The threshold of slow command which is used for writing operation (in milliseconds). | SW_SLOW_CACHE_WRITE_THRESHOLD | `default:20,redis:10` | -| - | - | slowCacheReadThreshold | The threshold of slow command which is used for reading (getting) operation (in milliseconds). | SW_SLOW_CACHE_READ_THRESHOLD | `default:20,redis:10` | +| - | - | meterAnalyzerActiveFiles | Indicates which files could be instrumented and analyzed. Multiple files are split by ",". | SW_METER_ANALYZER_ACTIVE_FILES | datasource,threadpool,satellite,go-runtime,python-runtime,continuous-profiling,java-agent,go-agent,ruby-runtime,php-runtime,nodejs-runtime,gen-ai-model | | +| - | - | slowCacheWriteThreshold | The threshold of slow command which is used for writing operation (in milliseconds). | SW_SLOW_CACHE_SLOW_WRITE_THRESHOLD | `default:20,redis:10` | +| - | - | slowCacheReadThreshold | The threshold of slow command which is used for reading (getting) operation (in milliseconds). | SW_SLOW_CACHE_SLOW_READ_THRESHOLD | `default:20,redis:10` | | receiver-sharing-server | default | Sharing server provides new gRPC and restful servers for data collection. Ana designates that servers in the core module are to be used for internal communication only. | - | - | | | - | - | restHost | Binding IP of RESTful services. Services include GraphQL query and HTTP data report. | SW_RECEIVER_SHARING_REST_HOST | - | | - | - | restPort | Binding port of RESTful services. | SW_RECEIVER_SHARING_REST_PORT | - | @@ -269,7 +269,7 @@ It divided into several modules, each of which has its own settings. The followi | - | - | peerHost | The Cilium Peer Service Host. | SW_CILIUM_FETCHER_PEER_HOST | hubble-peer.kube-system.svc.cluster.local | | - | - | peerPort | The Cilium Peer Service Port. | SW_CILIUM_FETCHER_PEER_PORT | 80 | | - | - | fetchFailureRetrySecond | The Cilium fetch observe data failure retry interval(second). | SW_CILIUM_FETCHER_FETCH_FAILURE_RETRY_SECOND | 10 | -| - | - | sslConnection | The Cilium fetch protocol is TLS enabled or not. | eSW_CILIUM_FETCHER_SSL_CONNECTION | false | +| - | - | sslConnection | The Cilium fetch protocol is TLS enabled or not. | SW_CILIUM_FETCHER_SSL_CONNECTION | false | | - | - | sslPrivateKeyFile | The Cilium TLS fetch private key file path. | SW_CILIUM_FETCHER_PRIVATE_KEY_FILE_PATH | "" | | - | - | sslCertChainFile | The Cilium TLS fetch cert chain file path. | SW_CILIUM_FETCHER_CERT_CHAIN_FILE_PATH | "" | | - | - | sslCaFile | The Cilium TLS fetch rot CA Certification file path. | SW_CILIUM_FETCHER_CA_FILE_PATH | "" | @@ -361,9 +361,9 @@ It divided into several modules, each of which has its own settings. The followi | - | - | namespace | Namespace for SkyWalking cluster. | SW_CONFIG_ETCD_NAMESPACE | /skywalking | | - | - | authentication | Indicates whether there is authentication. | SW_CONFIG_ETCD_AUTHENTICATION | false | | - | - | user | Etcd auth username. | SW_CONFIG_ETCD_USER | | -| - | - | password | Etcd auth password. | SW_CONFIG_ETCD_PASSWORD | | +| - | - | password | Etcd auth password. | SW_CONFIG_ETCD_password | | | - | - | period | The period of data sync (in seconds). | SW_CONFIG_ETCD_PERIOD | 60 | -| - | consul | hostAndPorts | Hosts and ports for Consul cluster. | SW_CONFIG_CONSUL_HOST_AND_PORTS | localhost:8500 | +| - | consul | hostAndPorts | Hosts and ports for Consul cluster. | SW_CONFIG_CONSUL_HOST_AND_PORTS | 1.2.3.4:8500 | | - | - | aclToken | ACL Token of Consul. Empty string means `without ACL token`. | SW_CONFIG_CONSUL_ACL_TOKEN | - | | - | - | period | The period of data sync (in seconds). | SW_CONFIG_CONSUL_PERIOD | 60 | | - | k8s-configmap | namespace | Deployment namespace of the config map. | SW_CLUSTER_K8S_NAMESPACE | default | @@ -395,7 +395,7 @@ It divided into several modules, each of which has its own settings. The followi | ui-management | default | (selector) | UI Management REST surface on admin-server — /ui-management/templates (CRUD) for dashboard templates. Consumed by Horizon UI; replaces the retired GraphQL `UIConfigurationManagement` template resolver. The sidebar menu is NOT served (Horizon UI owns it client-side). Routes only on the admin-server register. **Enabled by default**; set SW_UI_MANAGEMENT to `-` to disable. | SW_UI_MANAGEMENT | default | | configuration-discovery | default | disableMessageDigest | If true, agent receives the latest configuration every time, even without making any changes. By default, OAP uses the SHA512 message digest mechanism to detect changes in configuration. | SW_DISABLE_MESSAGE_DIGEST | false | | receiver-event | default | gRPC services that handle events data. | - | - | | -| aws-firehose-receiver | default | host | Binding IP of HTTP server | SW_RECEIVER_AWS_FIREHOSE_HTTP_HOST | 0.0.0.0 | +| aws-firehose | default | host | Binding IP of HTTP server | SW_RECEIVER_AWS_FIREHOSE_HTTP_HOST | 0.0.0.0 | | - | - | port | Binding port of HTTP server | SW_RECEIVER_AWS_FIREHOSE_HTTP_PORT | 12801 | | - | - | contextPath | Context path of HTTP server | SW_RECEIVER_AWS_FIREHOSE_HTTP_CONTEXT_PATH | / | | - | - | idleTimeOut | Idle timeout of a connection for keep-alive. | SW_RECEIVER_AWS_FIREHOSE_HTTP_IDLE_TIME_OUT | 30000 |