Skip to content

HDDS-12920. Configure log4j to gzip rolled over service log files #8357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adoroszlai merged 9 commits into from
May 2, 2025
Merged

HDDS-12920. Configure log4j to gzip rolled over service log files #8357

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b5cb7c8
HDDS-12920. Added log4j properties and dependency for gzip compressio…
Apr 28, 2025
a376862
Updated log4j root logger
Apr 28, 2025
9bdb446
Merge branch 'master' of github.com:apache/ozone into HDDS-12920
Apr 28, 2025
6a760df
Merge branch 'master' of github.com:apache/ozone into HDDS-12920
Apr 29, 2025
add0850
Added dependency to LICENCE and jar-report
Apr 29, 2025
6a9d17c
Added description for DRFA properties
Apr 29, 2025
68125b1
Added scope as runtime and removed dependency from ozone-dist pom.xml
Apr 29, 2025
21b0cd3
Updated log4j properties and added dependency to hdds-server-framework
Apr 30, 2025
698551d
Updated FileNamePattern
May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions hadoop-hdds/container-service/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@
<groupId>jakarta.xml.bind</groupId>
<artifactId>jakarta.xml.bind-api</artifactId>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>apache-log4j-extras</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
Expand Down
4 changes: 4 additions & 0 deletions hadoop-hdds/server-scm/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>apache-log4j-extras</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
Expand Down
4 changes: 4 additions & 0 deletions hadoop-ozone/dist/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
</properties>

<dependencies>
<dependency>
<groupId>log4j</groupId>
<artifactId>apache-log4j-extras</artifactId>
</dependency>
<dependency>
<groupId>org.apache.ozone</groupId>
<artifactId>hdds-container-service</artifactId>
Expand Down
1 change: 1 addition & 0 deletions hadoop-ozone/dist/src/main/license/bin/LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@ Apache License 2.0
jakarta.validation:jakarta.validation-api
javax.enterprise:cdi-api
javax.inject:javax.inject
log4j:apache-log4j-extras
net.java.dev.jna:jna
net.java.dev.jna:jna-platform
org.apache.commons:commons-compress
Expand Down
1 change: 1 addition & 0 deletions hadoop-ozone/dist/src/main/license/jar-report.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ share/ozone/lib/aircompressor.jar
share/ozone/lib/animal-sniffer-annotations.jar
share/ozone/lib/annotations.jar
share/ozone/lib/annotations.jar
share/ozone/lib/apache-log4j-extras.jar
share/ozone/lib/aopalliance.jar
share/ozone/lib/aopalliance-repackaged.jar
share/ozone/lib/asm-analysis.jar
Expand Down
29 changes: 24 additions & 5 deletions hadoop-ozone/dist/src/shell/conf/log4j.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,38 @@ log4j.appender.ASYNCRFA.maxBackupIndex=${hadoop.log.maxbackupindex}
log4j.appender.ASYNCRFA.conversionPattern=%d{ISO8601} [%t] %p %c: %m%n

#
# Daily Rolling File Appender
# Daily Rolling File Appender that gzip rolled over log files
#

log4j.appender.DRFA=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DRFA.File=${hadoop.log.dir}/${hadoop.log.file}
log4j.appender.DRFA=org.apache.log4j.rolling.RollingFileAppender
log4j.appender.DRFA.rollingPolicy=org.apache.log4j.rolling.FixedWindowRollingPolicy
log4j.appender.DRFA.triggeringPolicy=org.apache.log4j.rolling.SizeBasedTriggeringPolicy

# Rollover at midnight
log4j.appender.DRFA.DatePattern=.yyyy-MM-dd
log4j.appender.DRFA.rollingPolicy.ActiveFileName=${hadoop.log.dir}/${hadoop.log.file}
log4j.appender.DRFA.rollingPolicy.FileNamePattern=${hadoop.log.dir}/${hadoop.log.file}-%i.log.gz
#MaxFileSize param accepts a long value
log4j.appender.DRFA.triggeringPolicy.MaxFileSize=268435456
log4j.appender.DRFA.rollingPolicy.maxIndex=10
Copy link
Contributor

@jojochuang jojochuang Apr 29, 2025

Choose a reason for hiding this comment

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

This'll retain up to 10 256MB compressed log files. That should be good enough for most cases.


log4j.appender.DRFA.layout=org.apache.log4j.PatternLayout

# Pattern format: Date LogLevel LoggerName LogMessage
log4j.appender.DRFA.layout.ConversionPattern=%d{ISO8601} [%t] %p %c: %m%n

#
# Daily Rolling File Appender that creates a new log file each day based on date pattern
#

Copy link
Contributor

@tanvipenumudy tanvipenumudy Apr 29, 2025

Choose a reason for hiding this comment

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

NIT: We can provide a small one-line description of what the older commented-out properties do, if someone wants to re-enable them.

#log4j.appender.DRFA=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.DRFA.File=${hadoop.log.dir}/${hadoop.log.file}

# Rollover at midnight
#log4j.appender.DRFA.DatePattern=.yyyy-MM-dd

#log4j.appender.DRFA.layout=org.apache.log4j.PatternLayout

# Pattern format: Date LogLevel LoggerName LogMessage
#log4j.appender.DRFA.layout.ConversionPattern=%d{ISO8601} [%t] %p %c: %m%n
# Debugging Pattern format
#log4j.appender.DRFA.layout.ConversionPattern=%d{ISO8601} [%t] %-5p %c{2} (%F:%M(%L)) - %m%n

Expand Down
4 changes: 4 additions & 0 deletions hadoop-ozone/ozone-manager/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>apache-log4j-extras</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
Expand Down
11 changes: 11 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,17 @@
<artifactId>joda-time</artifactId>
<version>${joda.time.version}</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>apache-log4j-extras</artifactId>
<version>1.2.17</version>
<exclusions>
<exclusion>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna</artifactId>
Expand Down