Added Zstandard compression support (#1508, #1514)

Author: vy

log4j-core-test/pom.xml

@@ -354,6 +354,11 @@
       <artifactId>xz</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.github.luben</groupId>
+      <artifactId>zstd-jni</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

log4j-core-test/src/test/java/org/apache/logging/log4j/core/appender/rolling/RollingAppenderSizeTest.java

@@ -59,7 +59,8 @@ public class RollingAppenderSizeTest {
             "bz2",
             "deflate",
             "pack200",
-            "xz");
+            "xz",
+            "zst");
 
     static Stream<Arguments> parameters() {
         return FILE_EXTENSIONS.stream().flatMap(fileExtension -> {

log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/FileExtension.java

@@ -46,33 +46,41 @@ public Action createCompressAction(final String renameTo, final String compresse
         @Override
         public Action createCompressAction(final String renameTo, final String compressedName, final boolean deleteSource,
                                     final int compressionLevel) {
-            // One of "gz", "bzip2", "xz", "pack200", or "deflate".
+            // One of "gz", "bzip2", "xz", "zst", "pack200", or "deflate".
             return new CommonsCompressAction("bzip2", source(renameTo), target(compressedName), deleteSource);
         }
     },
     DEFLATE(".deflate") {
         @Override
         public Action createCompressAction(final String renameTo, final String compressedName, final boolean deleteSource,
                                     final int compressionLevel) {
-            // One of "gz", "bzip2", "xz", "pack200", or "deflate".
+            // One of "gz", "bzip2", "xz", "zst", "pack200", or "deflate".
             return new CommonsCompressAction("deflate", source(renameTo), target(compressedName), deleteSource);
         }
     },
     PACK200(".pack200") {
         @Override
         public Action createCompressAction(final String renameTo, final String compressedName, final boolean deleteSource,
                                     final int compressionLevel) {
-            // One of "gz", "bzip2", "xz", "pack200", or "deflate".
+            // One of "gz", "bzip2", "xz", "zst", "pack200", or "deflate".
             return new CommonsCompressAction("pack200", source(renameTo), target(compressedName), deleteSource);
         }
     },
     XZ(".xz") {
         @Override
         public Action createCompressAction(final String renameTo, final String compressedName, final boolean deleteSource,
                                     final int compressionLevel) {
-            // One of "gz", "bzip2", "xz", "pack200", or "deflate".
+            // One of "gz", "bzip2", "xz", "zstd", "pack200", or "deflate".
             return new CommonsCompressAction("xz", source(renameTo), target(compressedName), deleteSource);
         }
+    },
+    ZSTD(".zst") {
+        @Override
+        public Action createCompressAction(final String renameTo, final String compressedName, final boolean deleteSource,
+            final int compressionLevel) {
+            // One of "gz", "bzip2", "xz", "zstd", "pack200", or "deflate".
+            return new CommonsCompressAction("zstd", source(renameTo), target(compressedName), deleteSource);
+        }
     };
 
     public static FileExtension lookup(final String fileExtension) {

log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/CommonsCompressAction.java

@@ -36,7 +36,7 @@ public final class CommonsCompressAction extends AbstractAction {
     private static final int BUF_SIZE = 8192;
 
     /**
-     * Compressor name. One of "gz", "bzip2", "xz", "pack200" or "deflate".
+     * Compressor name. One of "gz", "bzip2", "xz", "zst", "pack200" or "deflate".
      */
     private final String name;
 
@@ -58,7 +58,7 @@ public final class CommonsCompressAction extends AbstractAction {
     /**
      * Creates new instance of Bzip2CompressAction.
      *
-     * @param name the compressor name. One of "gz", "bzip2", "xz", "pack200", or "deflate".
+     * @param name the compressor name. One of "gz", "bzip2", "xz", "zst", "pack200", or "deflate".
      * @param source file to compress, may not be null.
      * @param destination compressed file, may not be null.
      * @param deleteSource if true, attempt to delete file on completion. Failure to delete does not cause an exception
@@ -88,7 +88,7 @@ public boolean execute() throws IOException {
     /**
      * Compresses a file.
      *
-     * @param name the compressor name, i.e. "gz", "bzip2", "xz", "pack200", or "deflate".
+     * @param name the compressor name, i.e. "gz", "bzip2", "xz", "zstd", "pack200", or "deflate".
      * @param source file to compress, may not be null.
      * @param destination compressed file, may not be null.
      * @param deleteSource if true, attempt to delete file on completion. Failure to delete does not cause an exception

log4j-parent/pom.xml

@@ -133,6 +133,7 @@
     <woodstox.version>6.5.1</woodstox.version>
     <xmlunit.version>2.9.1</xmlunit.version>
     <xz.version>1.9</xz.version>
+    <zstd.version>1.5.5-6</zstd.version>
 
     <!-- =====================================================
          Pinned transitive dependency version properties (in alphabetical order)
@@ -996,6 +997,12 @@
         <version>${xz.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>com.github.luben</groupId>
+        <artifactId>zstd-jni</artifactId>
+        <version>${zstd.version}</version>
+      </dependency>
+
     </dependencies>
   </dependencyManagement>
 

src/changelog/2.21.0/1508_fix-javadoc.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to you under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~      http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="http://logging.apache.org/log4j/changelog"
+       xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"
+       type="added">
+  <issue id="1508" link="https://github.com/apache/logging-log4j2/issues/1508"/>
+  <issue id="1514" link="https://github.com/apache/logging-log4j2/pull/1514"/>
+  <author id="github:anuragagarwal561994" name="Anurag Agarwal"/>
+  <author id="github:vy"/>
+  <description format="asciidoc">Added http://www.zstd.net/[ZStandard compression] support</description>
+</entry>

src/site/_release-notes/_2.21.0.adoc

@@ -47,6 +47,7 @@ The module name of four bridges (`log4j-slf4j-impl`, `log4j-slf4j2-impl`, `log4j
 === Added
 
 * Added marker parent support to `JsonTemplateLayout` (https://github.com/apache/logging-log4j2/pull/1381[1381])
+* Added http://www.zstd.net/[ZStandard compression] support (https://github.com/apache/logging-log4j2/issues/1508[1508], https://github.com/apache/logging-log4j2/pull/1514[1514])
 * Added a warning for incorrect syntax of highlighting styles (https://github.com/apache/logging-log4j2/issues/1545[1545], https://github.com/apache/logging-log4j2/pull/1637[1637])
 
 === Changed

src/site/xdoc/manual/appenders.xml

@@ -3322,10 +3322,14 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity {
                 is present it will be replaced with the current date and time values. If the pattern contains an integer
                 it will be incremented on each rollover. If the pattern contains both a date/time and integer
                 in the pattern the integer will be incremented until the result of the date/time pattern changes. If
-                the file pattern ends with ".gz", ".zip", ".bz2", ".deflate", ".pack200", or ".xz" the resulting archive
+                the file pattern ends with ".gz", ".zip", ".bz2", ".deflate", ".pack200", ".zst" or ".xz" the resulting archive
                 will be compressed using the compression scheme that matches the suffix. The formats bzip2, Deflate,
-                Pack200 and XZ require <a href="https://commons.apache.org/proper/commons-compress/">Apache Commons Compress</a>.
-                In addition, XZ requires <a href="https://tukaani.org/xz/java.html">XZ for Java</a>.
+                Pack200, XZ, and ZStandard require <a href="https://commons.apache.org/proper/commons-compress/">Apache Commons Compress</a>.
+                In addition:
+                <ul>
+                  <li>XZ requires <a href="https://tukaani.org/xz/java.html">xz-java</a></li>
+                  <li>ZStandard requires <a href="https://github.com/luben/zstd-jni">zstd-jni</a></li>
+                </ul>
                 The pattern may also contain lookup references that can be resolved at runtime such as is shown in the example
                 below.
               </p>

src/site/xdoc/runtime-dependencies.xml

@@ -285,7 +285,11 @@
         <tr>
           <td>Bzip2, Deflate, Pack200, and XZ compression on rollover</td>
           <td><a href="https://commons.apache.org/proper/commons-compress/">Apache Commons Compress</a>.
-            In addition, XZ requires <a href="https://tukaani.org/xz/java.html">XZ for Java</a>.
+            In addition:
+            <ul>
+              <li>XZ requires <a href="https://tukaani.org/xz/java.html">xz-java</a></li>
+              <li>ZStandard requires <a href="https://github.com/luben/zstd-jni">zstd-jni</a></li>
+            </ul>
           </td>
         </tr>
         <tr>