bitflicker64 commented on code in PR #528: URL: https://github.com/apache/hugegraph-doc/pull/528#discussion_r4277070198
########## content/en/docs/config/config-guide.md: ########## @@ -112,7 +112,11 @@ memory_monitor.period=2000 - `graphs`: The graph configuration directory, defaulting to `./conf/graphs`. Both `init-store.sh` and application initialization scan it; initialization attempts to load its properties files. - `graph.load_from_local_config`: Controls constructor preloading and rescanning on `reload()`, with source-code default `false`. It does not block local loading during application initialization and is not a security isolation switch. -> The upstream template still uses `arthas.telnet_port`, `arthas.http_port`, and `arthas.disabled_commands`, but `ServerOptions` reads the camelCase names in the example. Use `arthas.telnetPort`, `arthas.httpPort`, and `arthas.disabledCommands` in custom configurations. +> Starting with HugeGraph 1.8.0, use canonical snake_case options: `arthas.telnet_port`, `arthas.http_port`, and `arthas.disabled_commands`. +> Legacy camelCase names remain fallbacks; an explicitly set snake_case value wins and a conflicting alias produces a warning. Review Comment: Important: This line (and the matching text in `other.md` and `config-option.md`, EN and CN) says the camelCase names "remain fallbacks", but for most existing users they will be ignored after the upgrade, and the page does not tell them. The note this PR replaces told users to put `arthas.telnetPort`, `arthas.httpPort` and `arthas.disabledCommands` in custom configs, because 1.7.0 `ServerOptions` reads only those names. The 1.7.0 `rest-server.properties` template already ships `arthas.telnet_port=8562`, `arthas.http_port=8561` and `arthas.disabled_commands=jad`. So a config that followed that advice has both forms. In #2945, `ArthasAPI.option()` returns the snake_case value whenever that key is present (`config.containsKey(canonical.name())`), so after the upgrade the template values win. Custom ports go back to 8562/8561, and a hardened list such as `arthas.disabledCommands=jad,ognl,vmtool` drops back to `jad`. The only signal is a WARN logged when the agent is activated. Please add an upgrade note to config-guide (EN and CN), and point the other.md and config-option.md notes to it. It should say that if you set the camelCase keys as earlier versions of this page advised, you must move those values to the snake_case keys or delete the template's snake_case lines, because the snake_case lines in the shipped template take precedence. The #2945 runtime doc already says "Remove the unused alias to avoid ambiguity"; that sentence belongs here too. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
