1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
23 import org.apache.logging.log4j.core.Filter;
24 import org.apache.logging.log4j.core.Layout;
25 import org.apache.logging.log4j.core.LogEvent;
26 import org.apache.logging.log4j.core.config.Configuration;
27 import org.apache.logging.log4j.core.config.plugins.Plugin;
28 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
29 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
30 import org.apache.logging.log4j.core.config.plugins.PluginElement;
31 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
32 import org.apache.logging.log4j.core.layout.PatternLayout;
33 import org.apache.logging.log4j.core.net.Advertiser;
34 import org.apache.logging.log4j.core.util.Booleans;
35 import org.apache.logging.log4j.core.util.Integers;
36
37
38
39
40
41
42 @Plugin(name = "MemoryMappedFile", category = "Core", elementType = "appender", printObject = true)
43 public final class MemoryMappedFileAppender extends AbstractOutputStreamAppender<MemoryMappedFileManager> {
44
45 private static final long serialVersionUID = 1L;
46
47 private static final int BIT_POSITION_1GB = 30;
48 private static final int MAX_REGION_LENGTH = 1 << BIT_POSITION_1GB;
49 private static final int MIN_REGION_LENGTH = 256;
50
51 private final String fileName;
52 private Object advertisement;
53 private final Advertiser advertiser;
54
55 private MemoryMappedFileAppender(final String name, final Layout<? extends Serializable> layout,
56 final Filter filter, final MemoryMappedFileManager manager, final String filename,
57 final boolean ignoreExceptions, final boolean immediateFlush, final Advertiser advertiser) {
58 super(name, layout, filter, ignoreExceptions, immediateFlush, manager);
59 if (advertiser != null) {
60 final Map<String, String> configuration = new HashMap<>(layout.getContentFormat());
61 configuration.putAll(manager.getContentFormat());
62 configuration.put("contentType", layout.getContentType());
63 configuration.put("name", name);
64 advertisement = advertiser.advertise(configuration);
65 }
66 this.fileName = filename;
67 this.advertiser = advertiser;
68 }
69
70 @Override
71 public void stop() {
72 super.stop();
73 if (advertiser != null) {
74 advertiser.unadvertise(advertisement);
75 }
76 }
77
78
79
80
81
82
83 @Override
84 public void append(final LogEvent event) {
85
86
87
88
89
90
91
92 getManager().setEndOfBatch(event.isEndOfBatch());
93 super.append(event);
94 }
95
96
97
98
99
100
101 public String getFileName() {
102 return this.fileName;
103 }
104
105
106
107
108
109
110 public int getRegionLength() {
111 return getManager().getRegionLength();
112 }
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134 @PluginFactory
135 public static MemoryMappedFileAppender createAppender(
136
137 @PluginAttribute("fileName") final String fileName,
138 @PluginAttribute("append") final String append,
139 @PluginAttribute("name") final String name,
140 @PluginAttribute("immediateFlush") final String immediateFlush,
141 @PluginAttribute("regionLength") final String regionLengthStr,
142 @PluginAttribute("ignoreExceptions") final String ignore,
143 @PluginElement("Layout") Layout<? extends Serializable> layout,
144 @PluginElement("Filter") final Filter filter,
145 @PluginAttribute("advertise") final String advertise,
146 @PluginAttribute("advertiseURI") final String advertiseURI,
147 @PluginConfiguration final Configuration config) {
148
149
150 final boolean isAppend = Booleans.parseBoolean(append, true);
151 final boolean isForce = Booleans.parseBoolean(immediateFlush, false);
152 final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
153 final boolean isAdvertise = Boolean.parseBoolean(advertise);
154 final int regionLength = Integers.parseInt(regionLengthStr, MemoryMappedFileManager.DEFAULT_REGION_LENGTH);
155 final int actualRegionLength = determineValidRegionLength(name, regionLength);
156
157 if (name == null) {
158 LOGGER.error("No name provided for MemoryMappedFileAppender");
159 return null;
160 }
161
162 if (fileName == null) {
163 LOGGER.error("No filename provided for MemoryMappedFileAppender with name " + name);
164 return null;
165 }
166 if (layout == null) {
167 layout = PatternLayout.createDefaultLayout();
168 }
169 final MemoryMappedFileManager manager = MemoryMappedFileManager.getFileManager(fileName, isAppend, isForce,
170 actualRegionLength, advertiseURI, layout);
171 if (manager == null) {
172 return null;
173 }
174
175 return new MemoryMappedFileAppender(name, layout, filter, manager, fileName, ignoreExceptions, isForce,
176 isAdvertise ? config.getAdvertiser() : null);
177 }
178
179
180
181
182 private static int determineValidRegionLength(final String name, final int regionLength) {
183 if (regionLength > MAX_REGION_LENGTH) {
184 LOGGER.info("MemoryMappedAppender[{}] Reduced region length from {} to max length: {}", name, regionLength,
185 MAX_REGION_LENGTH);
186 return MAX_REGION_LENGTH;
187 }
188 if (regionLength < MIN_REGION_LENGTH) {
189 LOGGER.info("MemoryMappedAppender[{}] Expanded region length from {} to min length: {}", name, regionLength,
190 MIN_REGION_LENGTH);
191 return MIN_REGION_LENGTH;
192 }
193 final int result = Integers.ceilingNextPowerOfTwo(regionLength);
194 if (regionLength != result) {
195 LOGGER.info("MemoryMappedAppender[{}] Rounded up region length from {} to next power of two: {}", name,
196 regionLength, result);
197 }
198 return result;
199 }
200 }