You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@zookeeper.apache.org by "LoggingResearch (Jira)" <ji...@apache.org> on 2024/09/05 14:49:00 UTC
[jira] [Commented] (ZOOKEEPER-4855) Enhance Logging in AdminServerFactory to Reflect Configuration Changes
[ https://issues.apache.org/jira/browse/ZOOKEEPER-4855?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17879591#comment-17879591 ]
LoggingResearch commented on ZOOKEEPER-4855:
--------------------------------------------
To make it clear on how to fix the issue, we upload the comparison between the original version and the log-enhanced version in the attached file `original-vs-log-enhanced.md`. The log-enhanced version is generated automatically utilizing our proposed tool.
> Enhance Logging in AdminServerFactory to Reflect Configuration Changes
> ----------------------------------------------------------------------
>
> Key: ZOOKEEPER-4855
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-4855
> Project: ZooKeeper
> Issue Type: Improvement
> Components: server
> Affects Versions: 3.9.2
> Environment: Zookeeper Version: 3.9.2
> Location: {{{}`zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/admin/AdminServerFactory.java`{}}}, in {{{}`{}}}{*}{{createAdminServer}}{*}{{{}`{}}} method. Lines 41-61.
> Reporter: LoggingResearch
> Priority: Major
> Attachments: AdminServerFactoryTest.java, original-vs-log-enhanced.md
>
>
> The {{AdminServerFactory}} class in ZooKeeper creates an admin server based on a configuration parameter ({{{}zookeeper.admin.enableServer{}}}). Currently, there is no logging to indicate whether the server was enabled or disabled based on this parameter, which makes it difficult to troubleshoot or verify behavior during testing or in production. The enhancement proposes adding logging to capture this configuration decision, aiding in better diagnostics and understanding of server behavior.
>
> *Expected Behavior:*
> When the {{zookeeper.admin.enableServer}} property is set to {{{}"false"{}}}, the {{AdminServerFactory}} should log an informational message indicating that the JettyAdminServer is disabled. When the property is set to {{{}"true"{}}}, the server should start without additional logging related to this property, unless an error occurs.
>
> *How-to-Fix:*
> It's important to introduce required logging.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)