[ZEPPELIN-6459] Align Docker image logging configuration and documentation with Log4j2 - #5371
Open
celinayk wants to merge 1 commit into
Open
[ZEPPELIN-6459] Align Docker image logging configuration and documentation with Log4j2#5371celinayk wants to merge 1 commit into
celinayk wants to merge 1 commit into
Conversation
DockerInterpreterProcess uploaded log4j.properties and log4j_yarn_cluster.properties to interpreter containers but never log4j2.properties, even though bin/common.sh looks for it via -Dlog4j.configurationFile for every local interpreter process. Add it to the transferred file list and align docs/quickstart/docker.md's file list with the code. Investigation showed the ticket's premise that log4j.properties is obsolete Log4j 1.x cruft doesn't hold: Zeppelin's default SLF4J binding is slf4j-reload4j, so log4j.properties is still the primary logging config. log4j2.properties exists only for Flink's bundled real Log4j2 core. Document this in scripts/docker/zeppelin/bin/Dockerfile so the multiple log4j* COPY lines aren't mistaken for duplicates again, and clarify in docs/setup/deployment/docker.md that ZEPPELIN_IN_DOCKER applies to that all-in-one image, not the split zeppelin-server/ zeppelin-interpreter images. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
What is this PR for?
Docker-related scripts and docs still referenced Log4j 1.x style
log4j.propertiesfiles, and the reporter suspected these were obsolete leftovers from a Log4j2 migration. Investigation showed the opposite: Zeppelin's default SLF4J binding isslf4j-reload4j, solog4j.propertiesis still the primary logging config, whilelog4j2.propertiesexists only for Flink's bundled real Log4j2 core — both are required, not obsolete.The real bug found:
DockerInterpreterProcess(theDockerInterpreterLauncherfeature) uploadslog4j.propertiesandlog4j_yarn_cluster.propertiesfrom the hostto the interpreter container, but never
log4j2.properties, even thoughbin/common.shlooks for it via-Dlog4j.configurationFilefor every local interpreter process. This PR adds it to the transferred file list, alignsdocs/quickstart/docker.md's file list with the code, documents whyscripts/docker/zeppelin/bin/Dockerfileneeds all 4 log4j* files (so they aren't mistaken for duplicates again), and clarifies indocs/setup/deployment/docker.mdthatZEPPELIN_IN_DOCKERapplies to the all-in-one image, not the splitzeppelin-server/zeppelin-interpreterimages.What type of PR is it?
Bug Fix
Todos
log4j2.propertiestoDockerInterpreterProcess's container file transfer listdocs/quickstart/docker.md's transferred-file list with the codescripts/docker/zeppelin/bin/Dockerfileships 4 log4j* filesZEPPELIN_IN_DOCKERscope indocs/setup/deployment/docker.mdWhat is the Jira issue?
ZEPPELIN-6459
How should this be tested?
DockerInterpreterProcess#copyRunFileToContainer(it's private and untested), so no automated test was added for the transfer list
itself; existing
DockerInterpreterProcessTest(6 tests) still passes unchanged.DockerInterpreterProcessproducesusing the same
TarUtils/TarFileEntryproduction classes with the fixedcopyFilesentries, injected it into a real Alpine container via the sameupload-tar-then-extract mechanism
deployToContaineruses, and confirmedlog4j.properties,log4j2.properties, andlog4j_yarn_cluster.propertiesallland at the expected
conf/path inside the container with content identical(byte-for-byte
diff) to the host source files.Screenshots (if appropriate)
N/A (docs/config change, no UI impact)
Questions:
docs/quickstart/docker.mdanddocs/setup/deployment/docker.mdupdated as part of this PR