-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
StatusLogger.java
514 lines (460 loc) · 16.3 KB
/
StatusLogger.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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
/*
* 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.
*/
package org.apache.logging.log4j.status;
import java.io.Closeable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.message.MessageFactory;
import org.apache.logging.log4j.message.ParameterizedNoReferenceMessageFactory;
import org.apache.logging.log4j.simple.SimpleLogger;
import org.apache.logging.log4j.simple.SimpleLoggerContext;
import org.apache.logging.log4j.spi.AbstractLogger;
import org.apache.logging.log4j.util.Constants;
import org.apache.logging.log4j.util.PropertiesUtil;
/**
* Records events that occur in the logging system. By default, only error messages are logged to {@link System#err}.
* Normally, the Log4j StatusLogger is configured via the root {@code <Configuration status="LEVEL"/>} node in a Log4j
* configuration file. However, this can be overridden via a system property named
* {@value #DEFAULT_STATUS_LISTENER_LEVEL} and will work with any Log4j provider.
*
* @see SimpleLogger
* @see SimpleLoggerContext
*/
public final class StatusLogger extends AbstractLogger {
/**
* System property that can be configured with the number of entries in the queue. Once the limit is reached older
* entries will be removed as new entries are added.
*/
public static final String MAX_STATUS_ENTRIES = "log4j2.status.entries";
/**
* System property that can be configured with the {@link Level} name to use as the default level for
* {@link StatusListener}s.
*/
public static final String DEFAULT_STATUS_LISTENER_LEVEL = "log4j2.StatusLogger.level";
/**
* System property that can be configured with a date-time format string to use as the format for timestamps
* in the status logger output. See {@link java.text.SimpleDateFormat} for supported formats.
* @since 2.11.0
*/
public static final String STATUS_DATE_FORMAT = "log4j2.StatusLogger.DateFormat";
private static final long serialVersionUID = 2L;
private static final String NOT_AVAIL = "?";
static final PropertiesUtil PROPS = new PropertiesUtil("log4j2.StatusLogger.properties");
private static final int MAX_ENTRIES = PROPS.getIntegerProperty(MAX_STATUS_ENTRIES, 200);
private static final String DEFAULT_STATUS_LEVEL = PROPS.getStringProperty(DEFAULT_STATUS_LISTENER_LEVEL);
static final boolean DEBUG_ENABLED =
PropertiesUtil.getProperties().getBooleanProperty(Constants.LOG4J2_DEBUG, false, true);
// LOG4J2-1176: normal parameterized message remembers param object, causing memory leaks.
private static final StatusLogger STATUS_LOGGER = new StatusLogger(
StatusLogger.class.getName(),
ParameterizedNoReferenceMessageFactory.INSTANCE,
SimpleLoggerFactory.getInstance());
private final SimpleLogger logger;
private final Collection<StatusListener> listeners = new CopyOnWriteArrayList<>();
@SuppressWarnings("NonSerializableFieldInSerializableClass")
// ReentrantReadWriteLock is Serializable
private final ReadWriteLock listenersLock = new ReentrantReadWriteLock();
private final Queue<StatusData> messages = new BoundedQueue<>(MAX_ENTRIES);
@SuppressWarnings("NonSerializableFieldInSerializableClass")
// ReentrantLock is Serializable
private final Lock msgLock = new ReentrantLock();
private int listenersLevel;
/**
* Constructs the singleton instance for the STATUS_LOGGER constant.
* <p>
* This is now the logger level is set:
* </p>
* <ol>
* <li>If the property {@value Constants#LOG4J2_DEBUG} is {@code "true"}, then use {@link Level#TRACE}, otherwise,</li>
* <li>Use {@link Level#ERROR}</li>
* </ol>
* <p>
* This is now the listener level is set:
* </p>
* <ol>
* <li>If the property {@value #DEFAULT_STATUS_LISTENER_LEVEL} is set, then use <em>it</em>, otherwise,</li>
* <li>Use {@link Level#WARN}</li>
* </ol>
* <p>
* See:
* <ol>
* <li>LOG4J2-1813 Provide shorter and more intuitive way to switch on Log4j internal debug logging. If system property
* "log4j2.debug" is defined, print all status logging.</li>
* <li>LOG4J2-3340 StatusLogger's log Level cannot be changed as advertised.</li>
* </ol>
* </p>
*
* @param name The logger name.
* @param messageFactory The message factory.
*/
private StatusLogger(
final String name, final MessageFactory messageFactory, final SimpleLoggerFactory loggerFactory) {
super(name, messageFactory);
final Level loggerLevel = DEBUG_ENABLED ? Level.TRACE : Level.ERROR;
this.logger = loggerFactory.createSimpleLogger("StatusLogger", loggerLevel, messageFactory, System.err);
this.listenersLevel = Level.toLevel(DEFAULT_STATUS_LEVEL, Level.WARN).intLevel();
}
/**
* Retrieve the StatusLogger.
*
* @return The StatusLogger.
*/
public static StatusLogger getLogger() {
return STATUS_LOGGER;
}
public void setLevel(final Level level) {
logger.setLevel(level);
}
/**
* Registers a new listener.
*
* @param listener The StatusListener to register.
*/
public void registerListener(final StatusListener listener) {
listenersLock.writeLock().lock();
try {
listeners.add(listener);
final Level lvl = listener.getStatusLevel();
if (listenersLevel < lvl.intLevel()) {
listenersLevel = lvl.intLevel();
}
} finally {
listenersLock.writeLock().unlock();
}
}
/**
* Removes a StatusListener.
*
* @param listener The StatusListener to remove.
*/
public void removeListener(final StatusListener listener) {
closeSilently(listener);
listenersLock.writeLock().lock();
try {
listeners.remove(listener);
int lowest = Level.toLevel(DEFAULT_STATUS_LEVEL, Level.WARN).intLevel();
for (final StatusListener statusListener : listeners) {
final int level = statusListener.getStatusLevel().intLevel();
if (lowest < level) {
lowest = level;
}
}
listenersLevel = lowest;
} finally {
listenersLock.writeLock().unlock();
}
}
public void updateListenerLevel(final Level status) {
if (status.intLevel() > listenersLevel) {
listenersLevel = status.intLevel();
}
}
/**
* Returns a thread safe Iterable for the StatusListener.
*
* @return An Iterable for the list of StatusListeners.
*/
public Iterable<StatusListener> getListeners() {
return listeners;
}
/**
* Clears the list of status events and listeners.
*/
public void reset() {
listenersLock.writeLock().lock();
try {
for (final StatusListener listener : listeners) {
closeSilently(listener);
}
} finally {
listeners.clear();
listenersLock.writeLock().unlock();
// note this should certainly come after the unlock to avoid unnecessary nested locking
clear();
}
}
private static void closeSilently(final Closeable resource) {
try {
resource.close();
} catch (final IOException ignored) {
// ignored
}
}
/**
* Returns a List of all events as StatusData objects.
*
* @return The list of StatusData objects.
*/
public List<StatusData> getStatusData() {
msgLock.lock();
try {
return new ArrayList<>(messages);
} finally {
msgLock.unlock();
}
}
/**
* Clears the list of status events.
*/
public void clear() {
msgLock.lock();
try {
messages.clear();
} finally {
msgLock.unlock();
}
}
@Override
public Level getLevel() {
return logger.getLevel();
}
/**
* Adds an event.
*
* @param marker The Marker
* @param fqcn The fully qualified class name of the <b>caller</b>
* @param level The logging level
* @param msg The message associated with the event.
* @param t A Throwable or null.
*/
@Override
public void logMessage(
final String fqcn, final Level level, final Marker marker, final Message msg, final Throwable t) {
StackTraceElement element = null;
if (fqcn != null) {
element = getStackTraceElement(fqcn, Thread.currentThread().getStackTrace());
}
final StatusData data = new StatusData(element, level, msg, t, null);
msgLock.lock();
try {
messages.add(data);
} finally {
msgLock.unlock();
}
// LOG4J2-1813 if system property "log4j2.debug" is defined, all status logging is enabled
if (DEBUG_ENABLED || (listeners.size() <= 0)) {
logger.logMessage(fqcn, level, marker, msg, t);
} else {
for (final StatusListener listener : listeners) {
if (data.getLevel().isMoreSpecificThan(listener.getStatusLevel())) {
listener.log(data);
}
}
}
}
private StackTraceElement getStackTraceElement(final String fqcn, final StackTraceElement[] stackTrace) {
if (fqcn == null) {
return null;
}
boolean next = false;
for (final StackTraceElement element : stackTrace) {
final String className = element.getClassName();
if (next && !fqcn.equals(className)) {
return element;
}
if (fqcn.equals(className)) {
next = true;
} else if (NOT_AVAIL.equals(className)) {
break;
}
}
return null;
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final String message, final Throwable t) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final String message) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final String message, final Object... params) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level, final Marker marker, final String message, final Object p0, final Object p1) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6,
final Object p7) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6,
final Object p7,
final Object p8) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(
final Level level,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6,
final Object p7,
final Object p8,
final Object p9) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final CharSequence message, final Throwable t) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final Object message, final Throwable t) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker, final Message message, final Throwable t) {
return isEnabled(level, marker);
}
@Override
public boolean isEnabled(final Level level, final Marker marker) {
if (DEBUG_ENABLED) {
return true;
}
if (listeners.size() > 0) {
return listenersLevel >= level.intLevel();
}
return logger.isEnabled(level, marker);
}
/**
* Queues for status events.
*
* @param <E> Object type to be stored in the queue.
*/
private class BoundedQueue<E> extends ConcurrentLinkedQueue<E> {
private static final long serialVersionUID = -3945953719763255337L;
private final int size;
BoundedQueue(final int size) {
this.size = size;
}
@Override
public boolean add(final E object) {
super.add(object);
while (messages.size() > size) {
messages.poll();
}
return size > 0;
}
}
}