Skip to content

Fix configuration vocabulary rows that disagree with application.yml - #14250

Merged
wu-sheng merged 2 commits into
apache:masterfrom
farisbasha:docs-config-vocabulary-defaults
Nov 18, 2026
Merged

wu-sheng merged 2 commits into
apache:masterfrom
farisbasha:docs-config-vocabulary-defaults

Conversation

@farisbasha

Copy link
Copy Markdown
Contributor

Fix configuration vocabulary rows that disagree with application.yml

Several rows of docs/en/setup/backend/configuration-vocabulary.md name an environment variable, a setting or a default that is not what oap-server/server-starter/src/main/resources/application.yml uses. A user who copies the documented environment variable gets no effect. Each row now matches application.yml on master:

Row Doc said application.yml
core maxHttpUrisNumberPerService env SW_MAX_HTTP_URIS_NUMBER_PER_SERVICE SW_CORE_MAX_HTTP_URIS_NUMBER_PER_SVR (L143)
configuration/etcd period env SW_CONFIG_ZK_PERIOD SW_CONFIG_ETCD_PERIOD (L713)
configuration/k8s-configmap period env SW_CONFIG_ZK_PERIOD SW_CONFIG_CONFIGMAP_PERIOD (L727)
configuration/nacos period env SW_CONFIG_CONFIG_NACOS_PERIOD SW_CONFIG_NACOS_PERIOD (L740)
configuration/nacos group namespace text, SW_CONFIG_NACOS_SERVER_NAMESPACE, - SW_CONFIG_NACOS_SERVER_GROUP, skywalking (L736); added the missing namespace row (L738)
storage/elasticsearch setting name profileDataQueryScrollBatchSize profileDataQueryBatchSize (L210)
configuration/consul setting name hostPort hostAndPorts (L721)
indexReplicasNumber default 0 1 (L189)
health-checker checkIntervalSeconds default 5 30 (L768)
ai-pipeline baselineServerPort default 17128 18080 (L819)
searchableLogsTags default level level,http.status_code,ai_route_type (L126)
log-analyzer lalFiles / malFiles defaults default / "" the lists at L265-266
query-zipkin restContextPath default zipkin /zipkin (L596)
configuration/zookeeper namespace default `/`, root path /default (L707)

Docs only; no code changes. The table rows were compared with application.yml by a script that maps every ${SW_*:default} placeholder to its module and provider.

Not changed here: the etcd password row documents SW_CONFIG_ETCD_PASSWORD, but application.yml (L718) and dynamic-config-etcd.md use SW_CONFIG_ETCD_password (lower case), which is the only one of these variables that is not upper case. That looks like a typo in application.yml, but renaming it changes behaviour, so it is left for a maintainer to decide.

  • If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #.
  • Update the CHANGES log.

@wu-sheng wu-sheng added the chore Chores about the project, like code cleaning up, typos, upgrading dependencies, etc. label Nov 18, 2026
@wu-sheng wu-sheng added this to the 11.2.0 milestone Nov 18, 2026
@wu-sheng wu-sheng added the documentation Provide documents related issue or pull request only. label Nov 18, 2026
@wu-sheng

Copy link
Copy Markdown
Member

Thanks, the 16 rows changed here all match application.yml on master. Comparing the rest of the table against application.yml turns up a few more rows of the same kind that this PR still leaves wrong:

Row Doc says application.yml
agent-analyzer slowCacheReadThreshold env SW_SLOW_CACHE_READ_THRESHOLD SW_SLOW_CACHE_SLOW_READ_THRESHOLD (L259)
agent-analyzer slowCacheWriteThreshold env SW_SLOW_CACHE_WRITE_THRESHOLD SW_SLOW_CACHE_SLOW_WRITE_THRESHOLD (L260)
cilium-fetcher sslConnection env eSW_CILIUM_FETCHER_SSL_CONNECTION (stray e) SW_CILIUM_FETCHER_SSL_CONNECTION (L477)
agent-analyzer meterAnalyzerActiveFiles default empty datasource,threadpool,satellite,go-runtime,python-runtime,continuous-profiling,java-agent,go-agent,ruby-runtime,php-runtime,nodejs-runtime,gen-ai-model (L258)
configuration/consul hostAndPorts default localhost:8500 1.2.3.4:8500 (L721), also in dynamic-config-consul.md

The three environment variables are the same problem this PR fixes: setting the documented name has no effect. meterAnalyzerActiveFiles is the same case as lalFiles / malFiles. The Consul row is one this PR already edits, but its default still disagrees.

Two layout problems in the same table:

  • syncPeriodHttpUriRecognitionPattern, trainingPeriodHttpUriRecognitionPattern and maxHttpUrisNumberPerService (doc L101-103) sit at the end of the cluster / Nacos block, so they read as Nacos cluster settings. They are core settings (application.yml L139-143) and belong with the other core rows.
  • The Module column says aws-firehose-receiver (doc L398), but the module is aws-firehose (AWSFirehoseReceiverModule.NAME and the application.yml key). aws-firehose-receiver is only the plugin directory name.

On the etcd password row: every other row in this PR follows application.yml, so the doc should say SW_CONFIG_ETCD_password (as dynamic-config-etcd.md already does). Renaming the variable in application.yml is a behaviour change for existing users and can be a separate PR. Please update the changelog line to cover the extra rows.

@farisbasha

Copy link
Copy Markdown
Contributor Author

Thanks for the careful comparison! Updated in c56c37a:

  • slowCacheReadThreshold / slowCacheWriteThreshold env → SW_SLOW_CACHE_SLOW_READ_THRESHOLD / SW_SLOW_CACHE_SLOW_WRITE_THRESHOLD
  • Cilium fetcher sslConnection env → SW_CILIUM_FETCHER_SSL_CONNECTION (stray e removed)
  • meterAnalyzerActiveFiles default filled in from application.yml
  • Consul hostAndPorts default → 1.2.3.4:8500
  • etcd configuration password env → SW_CONFIG_ETCD_password (doc only, matching application.yml and dynamic-config-etcd.md)
  • moved syncPeriodHttpUriRecognitionPattern, trainingPeriodHttpUriRecognitionPattern and maxHttpUrisNumberPerService up under core
  • Module column aws-firehose-receiver → aws-firehose

The changelog line now covers these too.

@wu-sheng
wu-sheng merged commit c8850b4 into apache:master Nov 18, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Chores about the project, like code cleaning up, typos, upgrading dependencies, etc. documentation Provide documents related issue or pull request only.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants