[Doc] Fix incorrect description of sys_log_verbose_modules BE conf#69230
Open
sfwang218 wants to merge 1 commit intoStarRocks:mainfrom
Open
[Doc] Fix incorrect description of sys_log_verbose_modules BE conf#69230sfwang218 wants to merge 1 commit intoStarRocks:mainfrom
sfwang218 wants to merge 1 commit intoStarRocks:mainfrom
Conversation
… parameter Signed-off-by: wangshifa.1 <[email protected]>
Contributor
🌎 Translation Required?✅ All translation files are up to date.
|
Contributor
[Java-Extensions Incremental Coverage Report]✅ pass : 0 / 0 (0%) |
Contributor
[FE Incremental Coverage Report]✅ pass : 0 / 0 (0%) |
Contributor
[BE Incremental Coverage Report]✅ pass : 0 / 0 (0%) |
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
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.
Why I'm doing:
The current documentation for the
sys_log_verbose_modulesBE configuration parameter is incorrect. The description states that this parameter controls logging by BE namespace modules (e.g.,starrocks,starrocks::debug,starrocks::pipeline), but this is wrong.In reality,
sys_log_verbose_modulesspecifies source file names (without file extensions) or file name wildcards to control which files' VLOG output is enabled. This can be verified by examining the BE source code where glog's--vmoduleflag is used:// be/src/common/logging.cpp FLAGS_vmodule = config::sys_log_verbose_modules;The glog
--vmoduleflag documentation clearly states:For example:
sys_log_verbose_modules=storage_engine,tablet_managerenables VLOG output fromstorage_engine.cppandtablet_manager.cppsys_log_verbose_modules=*enables VLOG output from all source filesstarrocks::pipelinewhich are C++ namespaces, not file names.What I'm doing:
Update the
sys_log_verbose_modulesparameter description in BE_configuration.mdWhat type of PR is this:
Does this PR entail a change in behavior?
If yes, please specify the type of change:
Checklist:
Bugfix cherry-pick branch check: