-
Notifications
You must be signed in to change notification settings - Fork 136
/
GlassFishLogger.java
509 lines (428 loc) · 17.6 KB
/
GlassFishLogger.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
/*
* Copyright (c) 2022, 2024 Eclipse Foundation and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.main.jul;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.ResourceBundle;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.logging.Filter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.glassfish.main.jul.record.GlassFishLogRecord;
import org.glassfish.main.jul.record.MessageResolver;
import org.glassfish.main.jul.tracing.GlassFishLoggingTracer;
import static java.util.Objects.requireNonNull;
import static org.glassfish.main.jul.env.LoggingSystemEnvironment.isResolveLevelWithIncompleteConfiguration;
/**
* Custom {@link Logger}, integrated with {@link GlassFishLogManager}, so if the log manager is
* reconfiguring, the logger reacts on states of the log manager. Then log records can be
* redirected to a startup queue (if the logging is not configured or is reconfiguring)
* or the calling thread is blocked until the log manager finishes flushing of the queue)
* or processed as usually.
*
* @author David Matejcek
*/
public class GlassFishLogger extends Logger {
private static final MessageResolver MSG_RESOLVER = new MessageResolver();
private static final Function<Logger, Stream<Handler>> LOGER_TO_HANDLER = x -> Arrays.stream(x.getHandlers());
/**
* Creates a logger without predefined resource bundle.
*
* @param name a logger name
*/
protected GlassFishLogger(final String name) {
super(name, null);
}
/**
* Creates a copy of the logger. Used just in {@link GlassFishLogManager} for default system loggers.
*
* @param logger
*/
GlassFishLogger(final Logger logger) {
// resource bundle name is taken from the set resource bundle
super(requireNonNull(logger, "logger is null!").getName(), null);
if (System.getSecurityManager() == null) {
initMe(logger);
return;
}
PrivilegedAction<Void> action = () -> {
initMe(logger);
return null;
};
AccessController.doPrivileged(action);
}
private void initMe(final Logger logger) {
setLevel(logger.getLevel());
setUseParentHandlers(logger.getUseParentHandlers());
setFilter(logger.getFilter());
if (logger.getParent() != null) {
setParent(logger.getParent());
}
if (logger.getResourceBundle() != null) {
setResourceBundle(logger.getResourceBundle());
}
for (final Handler handler : logger.getHandlers()) {
addHandler(handler);
}
}
@Override
public void setLevel(final Level newLevel) throws SecurityException {
GlassFishLoggingTracer.trace(GlassFishLogger.class, () -> "setLevel(" + newLevel + "); this: " + this);
super.setLevel(newLevel);
}
@Override
public void addHandler(final Handler handler) throws SecurityException {
GlassFishLoggingTracer.trace(GlassFishLogger.class, () -> "addHandler(" + handler + "); this: " + this);
super.addHandler(handler);
}
@Override
public void removeHandler(final Handler handler) throws SecurityException {
GlassFishLoggingTracer.trace(GlassFishLogger.class, () -> "removeHandler(" + handler + "); this: " + this);
super.removeHandler(handler);
}
@Override
public String toString() {
return super.toString() + "['" + getName() + "':" + getLevel() + "]";
}
/**
* Searches for a handler of some type and returns the first found.
* Note: the comparison uses Class.equals, so it respects classloaders.
*
* @param <T> {@link Handler} type.
* @param type
* @return found handler or null.
*/
public <T extends Handler> T getHandler(final Class<T> type) {
return type.cast(Arrays.stream(getHandlers()).filter(h -> h.getClass().equals(type)).findFirst().orElse(null));
}
/**
* Uses {@link #getHandlers()} and filters output to return only handlers implementing the class
* from a parameter.
*
* @param type type used for filtering; can be also an interface
* @return list of found handlers (may be empty but never null)
*/
public List<Handler> getHandlers(final Class<?> type) {
return Arrays.stream(getHandlers()).filter(type::isInstance).collect(Collectors.toList());
}
@Override
public void log(final Level level, final String msg) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msg);
record.setLoggerName(getName());
record.setResourceBundle(getResourceBundle());
record.setResourceBundleName(getResourceBundleName());
logOrQueue(record, status);
}
@Override
public void log(final Level level, final Supplier<String> msgSupplier) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msgSupplier.get());
record.setLoggerName(getName());
logOrQueue(record, status);
}
@Override
public void log(final Level level, final String msg, final Object param) {
log(level, msg, new Object[] {param});
}
@Override
public void log(final Level level, final String msg, final Object[] params) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msg);
record.setLoggerName(getName());
record.setResourceBundle(getResourceBundle());
record.setResourceBundleName(getResourceBundleName());
record.setParameters(params);
logOrQueue(record, status);
}
@Override
public void log(final Level level, final String msg, final Throwable thrown) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msg);
record.setLoggerName(getName());
record.setResourceBundle(getResourceBundle());
record.setResourceBundleName(getResourceBundleName());
record.setThrown(thrown);
logOrQueue(record, status);
}
@Override
public void log(final Level level, final Throwable thrown, final Supplier<String> msgSupplier) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msgSupplier.get());
record.setLoggerName(getName());
record.setThrown(thrown);
logOrQueue(record, status);
}
@Override
public void logp(final Level level, final String sourceClass, final String sourceMethod, final String msg) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
logOrQueue(level, status, sourceClass, sourceMethod, msg, null);
}
@Override
public void logp(final Level level, final String sourceClass, final String sourceMethod,
final Supplier<String> msgSupplier) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
logOrQueue(level, status, sourceClass, sourceMethod, msgSupplier.get(), null);
}
@Override
public void logp(final Level level, final String sourceClass, final String sourceMethod, final String msg,
final Object param) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
logOrQueue(level, status, sourceClass, sourceMethod, msg, null, param);
}
@Override
public void logp(final Level level, final String sourceClass, final String sourceMethod, final String msg,
final Object[] params) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
logOrQueue(level, status, sourceClass, sourceMethod, msg, null, params);
}
@Override
public void logp(final Level level, final String sourceClass, final String sourceMethod, final String msg,
final Throwable thrown) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
logOrQueue(level, status, sourceClass, sourceMethod, msg, thrown);
}
@Override
public void logp(final Level level, final String sourceClass, final String sourceMethod, final Throwable thrown,
final Supplier<String> msgSupplier) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
logOrQueue(level, status, sourceClass, sourceMethod, msgSupplier.get(), thrown);
}
@Override
public void logrb(final Level level, final String sourceClass, final String sourceMethod,
final ResourceBundle bundle, final String msg, final Object... params) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msg, false);
record.setLoggerName(getName());
record.setSourceClassName(sourceClass);
record.setSourceMethodName(sourceMethod);
record.setParameters(params);
if (bundle != null) {
record.setResourceBundleName(bundle.getBaseBundleName());
record.setResourceBundle(bundle);
}
logOrQueue(record, status);
}
@Override
public void logrb(final Level level, final String sourceClass, final String sourceMethod,
final ResourceBundle bundle, final String msg, final Throwable thrown) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msg, false);
record.setLoggerName(getName());
record.setSourceClassName(sourceClass);
record.setSourceMethodName(sourceMethod);
record.setThrown(thrown);
if (bundle != null) {
record.setResourceBundleName(bundle.getBaseBundleName());
record.setResourceBundle(bundle);
}
logOrQueue(record, status);
}
@Override
public void logrb(Level level, ResourceBundle bundle, String msg, Object... params) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(level, status)) {
return;
}
final LogRecord record = new GlassFishLogRecord(level, msg);
record.setLoggerName(getName());
if (params != null && params.length != 0) {
record.setParameters(params);
}
if (bundle != null) {
record.setResourceBundleName(bundle.getBaseBundleName());
record.setResourceBundle(bundle);
}
logOrQueue(record, status);
}
@Override
public void entering(final String sourceClass, final String sourceMethod, final Object[] params) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(Level.FINER, status)) {
return;
}
String msg = "ENTRY";
if (params == null || params.length == 0) {
logp(Level.FINER, sourceClass, sourceMethod, msg);
return;
}
// ' {i}' are 4 characters per parameter. Methods with many parameters will inflate.
final StringBuilder template = new StringBuilder(msg.length() + 4 * params.length).append(msg);
for (int i = 0; i < params.length; i++) {
template.append(" {").append(i).append('}');
}
logp(Level.FINER, sourceClass, sourceMethod, template.toString(), params);
}
@Override
public void throwing(final String sourceClass, final String sourceMethod, final Throwable thrown) {
logp(Level.FINER, sourceClass, sourceMethod, "THROW", thrown);
}
@Override
public void log(final LogRecord record) {
final GlassFishLoggingStatus status = getLoggingStatus();
if (!isProcessible(record.getLevel(), status)) {
return;
}
logOrQueue(record, status);
}
/**
* {@inheritDoc}
* <p>
* This method is <b>overriden</b> because it is called from clients to check if it makes
* sense to do some expensive preparation and call of any log method, but we don't
* know it yet, so we accept everything to queue (it should not be so many records).
*/
@Override
public boolean isLoggable(final Level level) {
return isProcessible(level, getLoggingStatus());
}
/**
* @param level a message logging level
* @param status the state of the logging system
* @return true if the given message level is currently being logged or if we don't know yet.
*/
protected boolean isProcessible(final Level level, final GlassFishLoggingStatus status) {
return isLoggableLevel(level) || !isLevelResolutionPossible(status);
}
/**
* @param level - log record level
* @return true if level has higher importance than level set to this logger (or parent)
*/
protected boolean isLoggableLevel(final Level level) {
return super.isLoggable(level);
}
private boolean isFullService(final GlassFishLoggingStatus status) {
return status == GlassFishLoggingStatus.FULL_SERVICE;
}
private boolean isLevelResolutionPossible(final GlassFishLoggingStatus status) {
return isResolveLevelWithIncompleteConfiguration() || status == GlassFishLoggingStatus.FLUSHING_BUFFERS
|| status == GlassFishLoggingStatus.FULL_SERVICE;
}
private boolean isToQueue(final GlassFishLoggingStatus status) {
return status == GlassFishLoggingStatus.UNCONFIGURED || status == GlassFishLoggingStatus.CONFIGURING;
}
void checkAndLog(final LogRecord record) {
if (!isLoggableLevel(record.getLevel())) {
return;
}
final Filter filter = getFilter();
if (filter != null && !filter.isLoggable(record)) {
return;
}
final Predicate<Handler> handlerFilter = h -> h.isLoggable(record);
final Iterator<Handler> handlers = getLoggers().stream().flatMap(LOGER_TO_HANDLER).filter(handlerFilter)
.iterator();
if (!handlers.hasNext()) {
return;
}
final GlassFishLogRecord resolvedLogRecord = MSG_RESOLVER.resolve(record);
handlers.forEachRemaining(h -> h.publish(resolvedLogRecord));
}
private List<Logger> getLoggers() {
final ArrayList<Logger> loggers = new ArrayList<>();
Logger log = this;
do {
loggers.add(log);
final boolean useParentHandlers = log.getUseParentHandlers();
if (!useParentHandlers) {
break;
}
log = log.getParent();
} while (log != null);
return loggers;
}
private GlassFishLoggingStatus getLoggingStatus() {
if (GlassFishLogManager.isGlassFishLogManager()) {
return GlassFishLogManager.getLogManager().getLoggingStatus();
}
return GlassFishLoggingStatus.FULL_SERVICE;
}
private void logOrQueue(final Level level, final GlassFishLoggingStatus status, final String sourceClass,
final String sourceMethod, final String msg, final Throwable thrown, final Object... params) {
final LogRecord record = new GlassFishLogRecord(level, msg, false);
record.setLoggerName(getName());
record.setResourceBundle(getResourceBundle());
record.setResourceBundleName(getResourceBundleName());
record.setSourceClassName(sourceClass);
record.setSourceMethodName(sourceMethod);
record.setThrown(thrown);
record.setParameters(params);
logOrQueue(record, status);
}
private void logOrQueue(final LogRecord record, final GlassFishLoggingStatus status) {
if (isFullService(status)) {
checkAndLog(record);
return;
}
if (isToQueue(status)) {
StartupQueue.getInstance().add(this, record);
return;
}
while (!isFullService(getLoggingStatus())) {
Thread.yield();
}
checkAndLog(record);
}
}