Surface BanyanDB config in /debugging/config/dump via a ConfigDumpExtension SPI#13932
Merged
Conversation
…sion SPI The BanyanDB storage config moved to a separate bydb.yml / bydb-topn.yml in 10.2.0, so a BanyanDB deployment showed an empty storage.banyandb block in the /debugging/config/dump admin API while ES/JDBC showed theirs. Add a generic ConfigDumpExtension SPI on ServerStatusService that any module loading configuration from a secondary file can implement. BanyanDB registers an extension that flattens its already-loaded, environment-resolved config into storage.banyandb.* (TopN rules under storage.banyandb.topN.*), merged into the same dump and masked centrally by the existing secret-keyword list. The status module stays storage-agnostic (dependency arrow plugin -> core); the Horizon UI needs no change since it groups by the first dotted segment. Adds UTs for the core merge+mask and the flattener, plus a representative config-dump assertion on the banyandb storage e2e case.
wu-sheng
added
backend
The 'Protect The Secrets' example showed the mask as '********' (8), but ServerStatusService.maskConfigValue returns '******' (6), which is also what the Horizon UI's isMasked check expects. Align the example with the actual output (matching the BanyanDB section added in this PR).
wankai123
approved these changes
Jun 30, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Surface the effective BanyanDB configuration (
bydb.yml/bydb-topn.yml) in the/debugging/config/dumpadmin APISince 10.2.0 the BanyanDB storage configuration lives in dedicated
bydb.yml/bydb-topn.ymlfiles, loaded into a POJO held privately byBanyanDBStorageProvider. The boot-time/debugging/config/dumponly reflectsapplication.yml, so a BanyanDB deployment showed an emptystorage.banyandbblock in the dump while ES/JDBC showed their full storage config — even thoughbydb.ymlis full of${ENV:default}placeholders, exactly what the dump promises to resolve.This adds a generic
ConfigDumpExtensionSPI onServerStatusService: any module that loads configuration from a secondary file can register an extension contributing extra effective rows, which are merged into the sameConfigListand masked centrally by the existing secret-keyword list.BanyanDBStorageProvider.start()registers an extension that flattens its already-loaded, environment-resolved config intostorage.banyandb.*(TopN rules understorage.banyandb.topN.*), reading the in-memory POJO rather than re-reading the file (so values are post-env-override, not raw${...}).CoreModulegetServiceseam; noModuleManagerchange).storagegroup, and masked values render via the existingv === '******'styling.Verified end-to-end against a live OAP + BanyanDB boot: text and JSON dump formats,
user/passwordmasked to******, env overrides resolved, warm+cold lifecycle stages and all TopN rules flattened correctly.If this is non-trivial feature, paste the links/URLs to the design doc.
Update the documentation to include this new feature.
Tests(including UT, IT, E2E) are added to verify the new feature.
If it's UI related, attach the screenshots below.
If this pull request closes/resolves/fixes an existing issue, replace the issue number. Closes #.
Update the
CHANGESlog.