You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Fix configuration vocabulary rows that disagree with application.yml - #14250
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:
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 #.
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:
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
choreChores about the project, like code cleaning up, typos, upgrading dependencies, etc.documentationProvide documents related issue or pull request only.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix configuration vocabulary rows that disagree with
application.ymlSeveral rows of
docs/en/setup/backend/configuration-vocabulary.mdname an environment variable, a setting or a default that is not whatoap-server/server-starter/src/main/resources/application.ymluses. A user who copies the documented environment variable gets no effect. Each row now matchesapplication.ymlon master:application.ymlmaxHttpUrisNumberPerServiceenvSW_MAX_HTTP_URIS_NUMBER_PER_SERVICESW_CORE_MAX_HTTP_URIS_NUMBER_PER_SVR(L143)periodenvSW_CONFIG_ZK_PERIODSW_CONFIG_ETCD_PERIOD(L713)periodenvSW_CONFIG_ZK_PERIODSW_CONFIG_CONFIGMAP_PERIOD(L727)periodenvSW_CONFIG_CONFIG_NACOS_PERIODSW_CONFIG_NACOS_PERIOD(L740)groupSW_CONFIG_NACOS_SERVER_NAMESPACE,-SW_CONFIG_NACOS_SERVER_GROUP,skywalking(L736); added the missingnamespacerow (L738)profileDataQueryScrollBatchSizeprofileDataQueryBatchSize(L210)hostPorthostAndPorts(L721)indexReplicasNumberdefault01(L189)checkIntervalSecondsdefault530(L768)baselineServerPortdefault1712818080(L819)searchableLogsTagsdefaultlevellevel,http.status_code,ai_route_type(L126)lalFiles/malFilesdefaultsdefault/""restContextPathdefaultzipkin/zipkin(L596)namespacedefault`/`, root path/default(L707)Docs only; no code changes. The table rows were compared with
application.ymlby a script that maps every${SW_*:default}placeholder to its module and provider.Not changed here: the etcd
passwordrow documentsSW_CONFIG_ETCD_PASSWORD, butapplication.yml(L718) anddynamic-config-etcd.mduseSW_CONFIG_ETCD_password(lower case), which is the only one of these variables that is not upper case. That looks like a typo inapplication.yml, but renaming it changes behaviour, so it is left for a maintainer to decide.CHANGESlog.