Skip to content

Fix Docker broker query log appender reference - #19626

Merged
Jackie-Jiang merged 1 commit into
apache:masterfrom
dlscjf151:fix/docker-querylog-appender
Sep 27, 2026
Merged

Jackie-Jiang merged 1 commit into
apache:masterfrom
dlscjf151:fix/docker-querylog-appender

Conversation

@dlscjf151

Copy link
Copy Markdown
Contributor

Summary

Fix the Docker broker Log4j2 configuration so QueryLogger references the declared querylog rolling-file appender.

The appender name is case-sensitive. The previous queryLog reference did not resolve, and additivity="false" prevented query records from falling back to the root appenders.

Fixes #19625.

Testing

  • Parsed docker/images/pinot/etc/conf/pinot-broker-log4j2.xml as XML.
  • Verified every AppenderRef resolves to a declared appender.
  • ./mvnw spotless:apply -N
  • ./mvnw license:format -N
  • ./mvnw checkstyle:check -N
  • ./mvnw license:check -N

@Jackie-Jiang Jackie-Jiang added the bug Something is not working as expected label Sep 26, 2026

@Jackie-Jiang Jackie-Jiang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we fix this by standardizing the appender name to queryLog in both broker Log4j configs? In the Docker config, change the appender declaration to queryLog and keep the existing queryLog reference. In pinot-tools/src/main/resources/conf/pinot-broker-log4j2.xml, change both the declaration and reference. This fixes the mismatch and aligns the appender name with brokerLog and brokerHelixLog in one pass. The querylog.log filename can stay unchanged.

@dlscjf151

Copy link
Copy Markdown
Contributor Author

Updated in 80f7551. I standardized the appender name to queryLog in both broker Log4j configurations while keeping the querylog.log filenames unchanged:

  • docker/images/pinot/etc/conf/pinot-broker-log4j2.xml
  • pinot-tools/src/main/resources/conf/pinot-broker-log4j2.xml

Validation completed for the root and pinot-tools scopes: XML parsing and appender-reference checks, Spotless, license format/check, Checkstyle, and git diff --check.

@Jackie-Jiang Jackie-Jiang added the backward-incompat Introduces a backward-incompatible API or behavior change label Sep 27, 2026
@Jackie-Jiang
Jackie-Jiang force-pushed the fix/docker-querylog-appender branch from 80f7551 to 6703881 Compare September 27, 2026 00:26
@Jackie-Jiang Jackie-Jiang removed the backward-incompat Introduces a backward-incompatible API or behavior change label Sep 27, 2026
@Jackie-Jiang

Copy link
Copy Markdown
Contributor

@dlscjf151 Since the file name is already querylog.log and changing that would be backward incompatible, decided to go with the original one line fix. Thanks!

@Jackie-Jiang
Jackie-Jiang merged commit 911ac36 into apache:master Sep 27, 2026
@Jackie-Jiang Jackie-Jiang added the docker Related to Docker images or containerization label Sep 27, 2026
xiangfu0 added a commit to pinot-contrib/pinot-docs that referenced this pull request Sep 27, 2026
Documents the operator-visible Docker broker query logging fix from
apache/pinot#19626 in upgrade notes.

Co-authored-by: Xiang Fu <xiangfu@Xiang-mac-mtv-2.local>
@xiangfu0

Copy link
Copy Markdown
Contributor

The Docker broker query logging fix is documented in the Pinot upgrade notes: pinot-contrib/pinot-docs#1070

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

Labels

bug Something is not working as expected docker Related to Docker images or containerization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docker broker Log4j config references a missing query log appender

3 participants