Skip to content

[Doc] Fix incorrect description of sys_log_verbose_modules BE conf#69230

Open
sfwang218 wants to merge 1 commit intoStarRocks:mainfrom
sfwang218:fix_vlog_conf_doc
Open

[Doc] Fix incorrect description of sys_log_verbose_modules BE conf#69230
sfwang218 wants to merge 1 commit intoStarRocks:mainfrom
sfwang218:fix_vlog_conf_doc

Conversation

@sfwang218
Copy link
Contributor

@sfwang218 sfwang218 commented Feb 12, 2026

Why I'm doing:

The current documentation for the sys_log_verbose_modules BE 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_modules specifies 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 --vmodule flag is used:

// be/src/common/logging.cpp
FLAGS_vmodule = config::sys_log_verbose_modules;

The glog --vmodule flag documentation clearly states:

Per-module verbose level. Argument is a comma-separated list of <module name>=<log level>. <module name> is a glob pattern, matched against the filename base (that is, name ignoring .cc/.h./-inl.h).

For example:

  • Setting sys_log_verbose_modules=storage_engine,tablet_manager enables VLOG output from storage_engine.cpp and tablet_manager.cpp
  • Setting sys_log_verbose_modules=* enables VLOG output from all source files
  • The old documentation incorrectly suggested using values like starrocks::pipeline which are C++ namespaces, not file names.

What I'm doing:

Update the sys_log_verbose_modules parameter description in BE_configuration.md

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
    • This pr needs auto generate documentation
  • This is a backport pr

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto-backported to the target branch
    • 4.1
    • 4.0
    • 3.5
    • 3.4

@github-actions github-actions bot added documentation Improvements or additions to documentation 4.1 3.5 4.0 3.4 labels Feb 12, 2026
@github-actions
Copy link
Contributor

🌎 Translation Required?

All translation files are up to date.
Great job! No translation actions are required for this PR.

🕒 Last updated: Thu, 12 Feb 2026 12:42:40 GMT

@github-actions
Copy link
Contributor

[Java-Extensions Incremental Coverage Report]

pass : 0 / 0 (0%)

@github-actions
Copy link
Contributor

[FE Incremental Coverage Report]

pass : 0 / 0 (0%)

@github-actions
Copy link
Contributor

[BE Incremental Coverage Report]

pass : 0 / 0 (0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.4 3.5 4.0 4.1 docs-maintainer documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant