HDDS-13383. Improve Logs in Ozone documentation. #8744
Merged
Conversation
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
The "Logs in Ozone" page was not very helpful. This patch improves it by: - Documenting which roles produce logs and how to configure them. - Documenting which roles produce audit logs and include a sample. - Explaining how to enable debug logs for both services and CLI tools. Change-Id: I5ffecd895f618278b507688a1a1579d6f5603d30
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR expands and clarifies the “Logs in Ozone” documentation by introducing structured sections for service logs, audit logs (with a sample entry), and debugging instructions.
- Updated front-matter summary to be more descriptive.
- Added a new “Service Logs” section listing where and how each service writes logs.
- Introduced “Audit Logs” details with configuration guidance and a sample entry.
- Added a “Debugging” section showing how to enable debug logs for both services and CLI tools.
Comments suppressed due to low confidence (3)
hadoop-hdds/docs/content/tools/LogsInOzone.md:4
- In the front-matter, remove any leading dash before
summary:to ensure valid YAML (e.g.,summary: ...instead of-summary:).
summary: An overview of logging in Apache Ozone.
hadoop-hdds/docs/content/tools/LogsInOzone.md:31
- Include example log file names for S3 Gateway and Recon as well (e.g.,
ozone-s3gateway-*.logandozone-recon-*.log) to complete the list of service logs.
* `ozone-om-....log` for Ozone Manager
hadoop-hdds/docs/content/tools/LogsInOzone.md:46
- List the actual default audit log file names (e.g.,
ozone-om-audit-log4j2.properties,ozone-scm-audit-log4j2.properties) or paths for clarity.
Audit log configurations are set in `*-audit-log4j2.properties` files. You can change the corresponding files to update the audit log policies for each component.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
The documentation for enabling debug logs for services was misleading. This commit clarifies that a service restart is required for log level changes to take effect. Change-Id: I12acc202e582d498ea4699e65026369b2591f06a
Contributor
Author
|
Merged. Thanks @ayushtkn |
jojochuang
added a commit
to jojochuang/ozone
that referenced
this pull request
Jul 31, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Generated-by: Google Gemini Pro 2.5 + Gemini Cli
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 changes were proposed in this pull request?
HDDS-13383. Improve Logs in Ozone documentation.
Please describe your PR in detail:
Tokens used:
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-13383
How was this patch tested?
Draft prepared by Gemini, reviewed and followed the cli instructions to confirm correctness.