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.rolling;
18  
19  import org.apache.logging.log4j.Logger;
20  import org.apache.logging.log4j.core.LogEvent;
21  import org.apache.logging.log4j.core.config.plugins.Plugin;
22  import org.apache.logging.log4j.core.config.plugins.PluginAttr;
23  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
24  import org.apache.logging.log4j.status.StatusLogger;
25  
26  import java.text.NumberFormat;
27  import java.text.ParseException;
28  import java.util.Locale;
29  import java.util.regex.Matcher;
30  import java.util.regex.Pattern;
31  
32  /**
33   *
34   */
35  @Plugin(name = "SizeBasedTriggeringPolicy", type = "Core", printObject = true)
36  public class SizeBasedTriggeringPolicy implements TriggeringPolicy {
37      /**
38       * Allow subclasses access to the status logger without creating another instance.
39       */
40      protected static final Logger LOGGER = StatusLogger.getLogger();
41  
42      private static final long KB = 1024;
43      private static final long MB = KB * KB;
44      private static final long GB = KB * MB;
45  
46      /**
47       * Rollover threshold size in bytes.
48       */
49      private static final long MAX_FILE_SIZE = 10 * 1024 * 1024; // let 10 MB the default max size
50  
51  
52      /**
53       * Pattern for string parsing.
54       */
55      private static final Pattern VALUE_PATTERN =
56          Pattern.compile("([0-9]+([\\.,][0-9]+)?)\\s*(|K|M|G)B?", Pattern.CASE_INSENSITIVE);
57  
58      private final long maxFileSize;
59  
60      private RollingFileManager manager;
61  
62      /**
63       * Constructs a new instance.
64       */
65      protected SizeBasedTriggeringPolicy() {
66          this.maxFileSize = MAX_FILE_SIZE;
67      }
68  
69      /**
70       * Constructs a new instance.
71       *
72       * @param maxFileSize rollover threshold size in bytes.
73       */
74      protected SizeBasedTriggeringPolicy(final long maxFileSize) {
75          this.maxFileSize = maxFileSize;
76      }
77  
78      /**
79       * Initialize the TriggeringPolicy.
80       * @param manager The RollingFileManager.
81       */
82      public void initialize(RollingFileManager manager) {
83          this.manager = manager;
84      }
85  
86  
87      /**
88       * Returns true if a rollover should occur.
89       * @param event   A reference to the currently event.
90       * @return true if a rollover should take place, false otherwise.
91       */
92      public boolean isTriggeringEvent(LogEvent event) {
93          return manager.getFileSize() > maxFileSize;
94      }
95  
96      @Override
97      public String toString() {
98          return "SizeBasedTriggeringPolicy(size=" + maxFileSize + ")";
99      }
100 
101     /**
102      * Create a SizeBasedTriggeringPolicy.
103      * @param size The size of the file before rollover is required.
104      * @return A SizeBasedTriggeringPolicy.
105      */
106     @PluginFactory
107     public static SizeBasedTriggeringPolicy createPolicy(@PluginAttr("size") String size) {
108 
109         long maxSize = size == null ? MAX_FILE_SIZE : valueOf(size);
110         return new SizeBasedTriggeringPolicy(maxSize);
111     }
112 
113     /**
114      * Converts a string to a number of bytes. Strings consist of a floating point value followed by
115      * K, M, or G for kilobytes, megabytes, gigabytes, respectively. The
116      * abbreviations KB, MB, and GB are also accepted. Matching is case insensitive.
117      *
118      * @param string The string to convert
119      * @return The Bytes value for the string
120      */
121     private static long valueOf(final String string) {
122         final Matcher matcher = VALUE_PATTERN.matcher(string);
123 
124         // Valid input?
125         if (matcher.matches()) {
126             try {
127                 // Get double precision value
128                 final long value = NumberFormat.getNumberInstance(Locale.getDefault()).parse(
129                     matcher.group(1)).longValue();
130 
131                 // Get units specified
132                 final String units = matcher.group(3);
133 
134                 if (units.equalsIgnoreCase("")) {
135                     return value;
136                 } else if (units.equalsIgnoreCase("K")) {
137                     return value * KB;
138                 } else if (units.equalsIgnoreCase("M")) {
139                     return value * MB;
140                 } else if (units.equalsIgnoreCase("G")) {
141                     return value * GB;
142                 } else {
143                     LOGGER.error("Units not recognized: " + string);
144                     return MAX_FILE_SIZE;
145                 }
146             } catch (ParseException e) {
147                 LOGGER.error("Unable to parse numeric part: " + string, e);
148                 return MAX_FILE_SIZE;
149             }
150         } else {
151             LOGGER.error("Unable to parse bytes: " + string);
152             return MAX_FILE_SIZE;
153         }
154     }
155 }