View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements. See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache license, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License. You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the license for the specific language governing permissions and
    15   * limitations under the license.
    16   */
    17  package org.apache.logging.log4j.core.appender;
    18
    19  import java.io.Serializable;
    20  import java.util.HashMap;
    21  import java.util.Map;
    22  import java.util.zip.Deflater;
    23
    24  import org.apache.logging.log4j.core.Filter;
    25  import org.apache.logging.log4j.core.Layout;
    26  import org.apache.logging.log4j.core.LogEvent;
    27  import org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy;
    28  import org.apache.logging.log4j.core.appender.rolling.RollingFileManager;
    29  import org.apache.logging.log4j.core.appender.rolling.RolloverStrategy;
    30  import org.apache.logging.log4j.core.appender.rolling.TriggeringPolicy;
    31  import org.apache.logging.log4j.core.config.Configuration;
    32  import org.apache.logging.log4j.core.config.plugins.Plugin;
    33  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
    34  import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
    35  import org.apache.logging.log4j.core.config.plugins.PluginElement;
    36  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
    37  import org.apache.logging.log4j.core.layout.PatternLayout;
    38  import org.apache.logging.log4j.core.net.Advertiser;
    39  import org.apache.logging.log4j.core.util.Booleans;
    40  import org.apache.logging.log4j.core.util.Integers;
    41
    42  /**
    43   * An appender that writes to files and can roll over at intervals.
    44   */
    45  @Plugin(name = "RollingFile", category = "Core", elementType = "appender", printObject = true)
    46  public final class RollingFileAppender extends AbstractOutputStreamAppender<RollingFileManager> {
    47
    48      private static final int DEFAULT_BUFFER_SIZE = 8192;
    49      private static final long serialVersionUID = 1L;
    50
    51      private final String fileName;
    52      private final String filePattern;
    53      private Object advertisement;
    54      private final Advertiser advertiser;
    55
    56
    57      private RollingFileAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
    58              final RollingFileManager manager, final String fileName, final String filePattern,
    59              final boolean ignoreExceptions, final boolean immediateFlush, final Advertiser advertiser) {
    60          super(name, layout, filter, ignoreExceptions, immediateFlush, manager);
    61          if (advertiser != null) {
    62              final Map<String, String> configuration = new HashMap<String, String>(layout.getContentFormat());
    63              configuration.put("contentType", layout.getContentType());
    64              configuration.put("name", name);
    65              advertisement = advertiser.advertise(configuration);
    66          }
    67          this.fileName = fileName;
    68          this.filePattern = filePattern;
    69          this.advertiser = advertiser;
    70      }
    71
    72      @Override
    73      public void stop() {
    74          super.stop();
    75          if (advertiser != null) {
    76              advertiser.unadvertise(advertisement);
    77          }
    78      }
    79
    80      /**
    81       * Write the log entry rolling over the file when required.
    82
    83       * @param event The LogEvent.
    84       */
    85      @Override
    86      public void append(final LogEvent event) {
    87          getManager().checkRollover(event);
    88          super.append(event);
    89      }
    90
    91      /**
    92       * Returns the File name for the Appender.
    93       * @return The file name.
    94       */
    95      public String getFileName() {
    96          return fileName;
    97      }
    98
    99      /**
    100      * Returns the file pattern used when rolling over.
    101      * @return The file pattern.
    102      */
    103     public String getFilePattern() {
    104         return filePattern;
    105     }
    106
    107     /**
    108      * Create a RollingFileAppender.
    109      * @param fileName The name of the file that is actively written to. (required).
    110      * @param filePattern The pattern of the file name to use on rollover. (required).
    111      * @param append If true, events are appended to the file. If false, the file
    112      * is overwritten when opened. Defaults to "true"
    113      * @param name The name of the Appender (required).
    114      * @param bufferedIO When true, I/O will be buffered. Defaults to "true".
    115      * @param bufferSizeStr buffer size for buffered IO (default is 8192).
    116      * @param immediateFlush When true, events are immediately flushed. Defaults to "true".
    117      * @param policy The triggering policy. (required).
    118      * @param strategy The rollover strategy. Defaults to DefaultRolloverStrategy.
    119      * @param layout The layout to use (defaults to the default PatternLayout).
    120      * @param filter The Filter or null.
    121      * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
    122      *               they are propagated to the caller.
    123      * @param advertise "true" if the appender configuration should be advertised, "false" otherwise.
    124      * @param advertiseURI The advertised URI which can be used to retrieve the file contents.
    125      * @param config The Configuration.
    126      * @return A RollingFileAppender.
    127      */
    128     @PluginFactory
    129     public static RollingFileAppender createAppender(
    130             @PluginAttribute("fileName") final String fileName,
    131             @PluginAttribute("filePattern") final String filePattern,
    132             @PluginAttribute("append") final String append,
    133             @PluginAttribute("name") final String name,
    134             @PluginAttribute("bufferedIO") final String bufferedIO,
    135             @PluginAttribute("bufferSize") final String bufferSizeStr,
    136             @PluginAttribute("immediateFlush") final String immediateFlush,
    137             @PluginElement("Policy") final TriggeringPolicy policy,
    138             @PluginElement("Strategy") RolloverStrategy strategy,
    139             @PluginElement("Layout") Layout<? extends Serializable> layout,
    140             @PluginElement("Filter") final Filter filter,
    141             @PluginAttribute("ignoreExceptions") final String ignore,
    142             @PluginAttribute("advertise") final String advertise,
    143             @PluginAttribute("advertiseURI") final String advertiseURI,
    144             @PluginConfiguration final Configuration config) {
    145
    146         final boolean isAppend = Booleans.parseBoolean(append, true);
    147         final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
    148         final boolean isBuffered = Booleans.parseBoolean(bufferedIO, true);
    149         final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
    150         final boolean isAdvertise = Boolean.parseBoolean(advertise);
    151         final int bufferSize = Integers.parseInt(bufferSizeStr, DEFAULT_BUFFER_SIZE);
    152         if (!isBuffered && bufferSize > 0) {
    153             LOGGER.warn("The bufferSize is set to {} but bufferedIO is not true: {}", bufferSize, bufferedIO);
    154         }
    155         if (name == null) {
    156             LOGGER.error("No name provided for FileAppender");
    157             return null;
    158         }
    159
    160         if (fileName == null) {
    161             LOGGER.error("No filename was provided for FileAppender with name "  + name);
    162             return null;
    163         }
    164
    165         if (filePattern == null) {
    166             LOGGER.error("No filename pattern provided for FileAppender with name "  + name);
    167             return null;
    168         }
    169
    170         if (policy == null) {
    171             LOGGER.error("A TriggeringPolicy must be provided");
    172             return null;
    173         }
    174
    175         if (strategy == null) {
    176             strategy = DefaultRolloverStrategy.createStrategy(null, null, null,
    177                     String.valueOf(Deflater.DEFAULT_COMPRESSION), config);
    178         }
    179
    180         if (layout == null) {
    181             layout = PatternLayout.createDefaultLayout();
    182         }
    183
    184         final RollingFileManager manager = RollingFileManager.getFileManager(fileName, filePattern, isAppend,
    185             isBuffered, policy, strategy, advertiseURI, layout, bufferSize);
    186         if (manager == null) {
    187             return null;
    188         }
    189
    190         return new RollingFileAppender(name, layout, filter, manager, fileName, filePattern,
    191                 ignoreExceptions, isFlush, isAdvertise ? config.getAdvertiser() : null);
    192     }
    193 }