-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
DefaultLoggingFactory.java
307 lines (266 loc) · 12 KB
/
DefaultLoggingFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
package io.dropwizard.logging;
import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.jmx.JMXConfigurator;
import ch.qos.logback.classic.jul.LevelChangePropagator;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.AsyncAppenderBase;
import ch.qos.logback.core.ConsoleAppender;
import ch.qos.logback.core.encoder.LayoutWrappingEncoder;
import ch.qos.logback.core.util.StatusPrinter;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.logback.InstrumentedAppender;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import io.dropwizard.jackson.Jackson;
import io.dropwizard.logback.AsyncAppenderBaseProxy;
import io.dropwizard.logging.async.AsyncAppenderFactory;
import io.dropwizard.logging.async.AsyncLoggingEventAppenderFactory;
import io.dropwizard.logging.filter.LevelFilterFactory;
import io.dropwizard.logging.filter.ThresholdLevelFilterFactory;
import io.dropwizard.logging.layout.DropwizardLayoutFactory;
import io.dropwizard.logging.layout.LayoutFactory;
import javax.annotation.Nullable;
import javax.management.InstanceAlreadyExistsException;
import javax.management.MBeanRegistrationException;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.NotCompliantMBeanException;
import javax.management.ObjectName;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import java.io.PrintStream;
import java.lang.management.ManagementFactory;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.TimeZone;
import java.util.concurrent.locks.ReentrantLock;
import static java.util.Objects.requireNonNull;
@JsonTypeName("default")
public class DefaultLoggingFactory implements LoggingFactory {
private static final ReentrantLock MBEAN_REGISTRATION_LOCK = new ReentrantLock();
private static final ReentrantLock CHANGE_LOGGER_CONTEXT_LOCK = new ReentrantLock();
@NotNull
private String level = "INFO";
@NotNull
private Map<String, JsonNode> loggers = Collections.emptyMap();
@Valid
@NotNull
private List<AppenderFactory<ILoggingEvent>> appenders = Collections.singletonList(new ConsoleAppenderFactory<>());
@JsonIgnore
private final LoggerContext loggerContext;
@JsonIgnore
private final PrintStream configurationErrorsStream;
public DefaultLoggingFactory() {
this(LoggingUtil.getLoggerContext(), System.err);
}
DefaultLoggingFactory(LoggerContext loggerContext, PrintStream configurationErrorsStream) {
super();
this.loggerContext = requireNonNull(loggerContext);
this.configurationErrorsStream = requireNonNull(configurationErrorsStream);
}
LoggerContext getLoggerContext() {
return loggerContext;
}
PrintStream getConfigurationErrorsStream() {
return configurationErrorsStream;
}
@JsonProperty
public String getLevel() {
return level;
}
@JsonProperty
public void setLevel(String level) {
this.level = level;
}
@JsonProperty
public Map<String, JsonNode> getLoggers() {
return loggers;
}
@JsonProperty
public void setLoggers(Map<String, JsonNode> loggers) {
this.loggers = new HashMap<>(loggers);
}
@JsonProperty
public List<AppenderFactory<ILoggingEvent>> getAppenders() {
return appenders;
}
@JsonProperty
public void setAppenders(List<AppenderFactory<ILoggingEvent>> appenders) {
this.appenders = new ArrayList<>(appenders);
}
@Override
public void configure(MetricRegistry metricRegistry, String name) {
LoggingUtil.hijackJDKLogging();
CHANGE_LOGGER_CONTEXT_LOCK.lock();
final Logger root;
try {
root = configureLoggers(name);
} finally {
CHANGE_LOGGER_CONTEXT_LOCK.unlock();
}
final LevelFilterFactory<ILoggingEvent> levelFilterFactory = new ThresholdLevelFilterFactory();
final AsyncAppenderFactory<ILoggingEvent> asyncAppenderFactory = new AsyncLoggingEventAppenderFactory();
final LayoutFactory<ILoggingEvent> layoutFactory = new DropwizardLayoutFactory();
for (AppenderFactory<ILoggingEvent> output : appenders) {
root.addAppender(output.build(loggerContext, name, layoutFactory, levelFilterFactory, asyncAppenderFactory));
}
StatusPrinter.setPrintStream(configurationErrorsStream);
try {
StatusPrinter.printIfErrorsOccured(loggerContext);
} finally {
StatusPrinter.setPrintStream(System.out);
}
final MBeanServer server = ManagementFactory.getPlatformMBeanServer();
MBEAN_REGISTRATION_LOCK.lock();
try {
final ObjectName objectName = new ObjectName("io.dropwizard:type=Logging");
if (!server.isRegistered(objectName)) {
server.registerMBean(new JMXConfigurator(loggerContext,
server,
objectName),
objectName);
}
} catch (MalformedObjectNameException | InstanceAlreadyExistsException |
NotCompliantMBeanException | MBeanRegistrationException e) {
throw new RuntimeException(e);
} finally {
MBEAN_REGISTRATION_LOCK.unlock();
}
configureInstrumentation(root, metricRegistry);
}
@Override
public void stop() {
// Should acquire the lock to avoid concurrent listener changes
CHANGE_LOGGER_CONTEXT_LOCK.lock();
try {
// We need to go through a list of appenders and locate the async ones,
// as those could have messages left to write. Since there is no flushing
// mechanism built into logback, we wait for a short period of time before
// giving up that the appender will be completely flushed.
final Logger logger = loggerContext.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
final Iterator<Appender<ILoggingEvent>> appenderIterator = logger.iteratorForAppenders();
while (appenderIterator.hasNext()) {
final Appender<ILoggingEvent> appender = appenderIterator.next();
if (appender instanceof AsyncAppenderBase) {
flushAppender((AsyncAppenderBase<?>) appender);
} else if (appender instanceof AsyncAppenderBaseProxy) {
flushAppender(((AsyncAppenderBaseProxy<?>) appender).getAppender());
}
}
} catch (InterruptedException ignored) {
// If the thread waiting for the logs to be flushed is aborted then
// user clearly wants the application to quit now, so stop trying
// to flush any appenders
Thread.currentThread().interrupt();
} finally {
CHANGE_LOGGER_CONTEXT_LOCK.unlock();
}
}
@Override
public void reset() {
CHANGE_LOGGER_CONTEXT_LOCK.lock();
try {
// Flush all the loggers and reinstate only the console logger as a
// sane default.
loggerContext.stop();
final Logger logger = loggerContext.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
logger.detachAndStopAllAppenders();
final DropwizardLayout formatter = new DropwizardLayout(loggerContext, TimeZone.getDefault());
formatter.start();
final LayoutWrappingEncoder<ILoggingEvent> layoutEncoder = new LayoutWrappingEncoder<>();
layoutEncoder.setLayout(formatter);
final ConsoleAppender<ILoggingEvent> consoleAppender = new ConsoleAppender<>();
consoleAppender.addFilter(new ThresholdLevelFilterFactory().build(Level.INFO));
consoleAppender.setEncoder(layoutEncoder);
consoleAppender.setContext(loggerContext);
consoleAppender.start();
logger.addAppender(consoleAppender);
loggerContext.start();
} finally {
CHANGE_LOGGER_CONTEXT_LOCK.unlock();
}
}
private void flushAppender(AsyncAppenderBase<?> appender) throws InterruptedException {
int timeWaiting = 0;
while (timeWaiting < appender.getMaxFlushTime() && appender.getNumberOfElementsInQueue() > 0) {
Thread.sleep(100);
timeWaiting += 100;
}
if (appender.getNumberOfElementsInQueue() > 0) {
// It may seem odd to log when we're trying to flush a logger that
// isn't flushing, but the same warning is issued inside
// appender.stop() if the appender isn't able to flush.
appender.addWarn(appender.getNumberOfElementsInQueue() + " events may be discarded");
}
}
private void configureInstrumentation(Logger root, MetricRegistry metricRegistry) {
final InstrumentedAppender appender = new InstrumentedAppender(metricRegistry);
appender.setContext(loggerContext);
appender.start();
root.addAppender(appender);
}
private Logger configureLoggers(String name) {
final Logger root = loggerContext.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
loggerContext.reset();
final LevelChangePropagator propagator = new LevelChangePropagator();
propagator.setContext(loggerContext);
propagator.setResetJUL(true);
loggerContext.addListener(propagator);
root.setLevel(toLevel(level));
final LevelFilterFactory<ILoggingEvent> levelFilterFactory = new ThresholdLevelFilterFactory();
final AsyncAppenderFactory<ILoggingEvent> asyncAppenderFactory = new AsyncLoggingEventAppenderFactory();
final LayoutFactory<ILoggingEvent> layoutFactory = new DropwizardLayoutFactory();
for (Map.Entry<String, JsonNode> entry : loggers.entrySet()) {
final Logger logger = loggerContext.getLogger(entry.getKey());
final JsonNode jsonNode = entry.getValue();
if (jsonNode.isTextual() || jsonNode.isBoolean()) {
// Just a level as a string
logger.setLevel(toLevel(jsonNode.asText()));
} else if (jsonNode.isObject()) {
// A level and an appender
final LoggerConfiguration configuration;
try {
configuration = Jackson.newObjectMapper().treeToValue(jsonNode, LoggerConfiguration.class);
} catch (JsonProcessingException e) {
throw new IllegalArgumentException("Wrong format of logger '" + entry.getKey() + "'", e);
}
logger.setLevel(toLevel(configuration.getLevel()));
logger.setAdditive(configuration.isAdditive());
for (AppenderFactory<ILoggingEvent> appender : configuration.getAppenders()) {
logger.addAppender(appender.build(loggerContext, name, layoutFactory, levelFilterFactory, asyncAppenderFactory));
}
} else {
throw new IllegalArgumentException("Unsupported format of logger '" + entry.getKey() + "'");
}
}
return root;
}
static Level toLevel(@Nullable String text) {
if ("false".equalsIgnoreCase(text)) {
// required because YAML maps "off" to a boolean false
return Level.OFF;
} else if ("true".equalsIgnoreCase(text)) {
// required because YAML maps "on" to a boolean true
return Level.ALL;
}
return Level.toLevel(text, Level.INFO);
}
@Override
public String toString() {
return "DefaultLoggingFactory{"
+ "level=" + level
+ ", loggers=" + loggers
+ ", appenders=" + appenders
+ '}';
}
}