/
PaxLoggingServiceImpl.java
610 lines (525 loc) · 23.3 KB
/
PaxLoggingServiceImpl.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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
/*
* Copyright 2005-2009 Niclas Hedhman.
*
* Licensed 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.ops4j.pax.logging.log4j1.internal;
import java.util.Dictionary;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.logging.Level;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
import org.apache.log4j.PaxLoggingConfigurator;
import org.apache.log4j.helpers.LogLog;
import org.ops4j.pax.logging.EventAdminPoster;
import org.ops4j.pax.logging.PaxContext;
import org.ops4j.pax.logging.PaxLogger;
import org.ops4j.pax.logging.PaxLoggingConstants;
import org.ops4j.pax.logging.PaxLoggingService;
import org.ops4j.pax.logging.spi.support.BackendSupport;
import org.ops4j.pax.logging.spi.support.ConfigurationNotifier;
import org.ops4j.pax.logging.spi.support.LogEntryImpl;
import org.ops4j.pax.logging.spi.support.LogReaderServiceImpl;
import org.ops4j.pax.logging.spi.support.OsgiUtil;
import org.ops4j.pax.logging.spi.support.PaxAppenderProxy;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceFactory;
import org.osgi.framework.ServiceReference;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.log.LogEntry;
import org.osgi.service.log.LogLevel;
/**
* Log4J1 specific implementation of {@link PaxLoggingService}. It's a {@link ServiceFactory}, so each
* bundle will get own instance of this service.
*/
public class PaxLoggingServiceImpl implements PaxLoggingService, ServiceFactory<Object> {
private final BundleContext m_bundleContext;
private volatile ReadWriteLock m_configLock;
private final boolean locking = true;
// LogReaderService registration as defined by org.osgi.service.log package
private final LogReaderServiceImpl m_logReader;
// pax-logging-log4j1 specific PaxContext for all MDC access
private final PaxContext m_context;
// optional bridging into Event Admin service
private final EventAdminPoster m_eventAdmin;
// optional notification mechanism for configuration events
private final ConfigurationNotifier m_configNotifier;
// Log level (actually a threashold) for this entire service.
private final LogLevel m_r7LogLevel = LogLevel.DEBUG;
// there's no need to run configureDefaults() more than once. That was happening in constructor
// and millisecond later during registration of ManagedService, upon receiving empty org.ops4j.pax.logging
// configuration
private final AtomicBoolean emptyConfiguration = new AtomicBoolean(false);
private Dictionary<String, String> defaultConfiguration = null;
public PaxLoggingServiceImpl(BundleContext context, LogReaderServiceImpl logReader, EventAdminPoster eventAdmin, ConfigurationNotifier configNotifier) {
if (context == null)
throw new IllegalArgumentException("bundleContext cannot be null");
m_bundleContext = context;
if (logReader == null)
throw new IllegalArgumentException("logReader cannot be null");
m_logReader = logReader;
if (eventAdmin == null)
throw new IllegalArgumentException("eventAdmin cannot be null");
m_eventAdmin = eventAdmin;
m_configNotifier = configNotifier;
m_context = new PaxContext();
String useLocks = OsgiUtil.systemOrContextProperty(context, PaxLoggingConstants.LOGGING_CFG_USE_LOCKS);
if (!"false".equalsIgnoreCase(useLocks)) {
// do not use locks ONLY if the property is "false". Otherwise (or if not set at all), use the locks
m_configLock = new ReentrantReadWriteLock();
}
}
/**
* Shut down the Pax Logging service. This will reset the logging configuration entirely, so it should only be
* used just before disposing of the service instance.
*/
protected void shutdown() {
LogManager.resetConfiguration();
// TODO: shouldn't we explicitly close the PaxAppenderProxy trackers? (I know they're closed anywye on bundle stop...)
}
/**
* Locks the configuration if needed
* @param useWriteLock whether to use {@link ReadWriteLock#readLock()} ({@code false})
* or {@link ReadWriteLock#writeLock()} ({@code true})
*/
void lock(boolean useWriteLock) {
ReadWriteLock lock = m_configLock;
if (lock != null) {
if (useWriteLock) {
lock.writeLock().lock();
} else {
lock.readLock().lock();
}
}
}
/**
* Unlocks the configuration if lock was used
* @param useWriteLock whether to use {@link ReadWriteLock#readLock()} ({@code false})
* or {@link ReadWriteLock#writeLock()} ({@code true})
*/
void unlock(boolean useWriteLock) {
ReadWriteLock lock = m_configLock;
if (lock != null) {
if (useWriteLock) {
lock.writeLock().unlock();
} else {
lock.readLock().unlock();
}
}
}
// org.ops4j.pax.logging.PaxLoggingService
@Override
public PaxLogger getLogger(Bundle bundle, String category, String fqcn) {
return getLogger(bundle, category, fqcn, false);
}
@Override
public LogLevel getLogLevel() {
return m_r7LogLevel;
}
// org.osgi.service.log.LogService
// these methods are actually never called directly, because the actual published
// methods come from service factory produced object - which passes correct FQCN
@Override
public void log(int level, String message) {
logImpl(null, level, message, null, "");
}
@Override
public void log(int level, String message, Throwable exception) {
logImpl(null, level, message, exception, "");
}
@Override
public void log(ServiceReference sr, int level, String message) {
logImpl(sr == null ? null : sr.getBundle(), level, message, null, "");
}
@Override
public void log(ServiceReference sr, int level, String message, Throwable exception) {
logImpl(sr == null ? null : sr.getBundle(), level, message, exception, "");
}
@Override
public PaxContext getPaxContext() {
return m_context;
}
// R7 org.osgi.service.log.LoggerFactory
@Override
public org.osgi.service.log.Logger getLogger(String name) {
return getLogger(null, name, PaxLoggerImpl.FQCN);
}
@Override
public org.osgi.service.log.Logger getLogger(Class<?> clazz) {
return getLogger(null, clazz.getName(), PaxLoggerImpl.FQCN);
}
@Override
public <L extends org.osgi.service.log.Logger> L getLogger(String name, Class<L> loggerType) {
return getLogger(null, name, loggerType);
}
@Override
public <L extends org.osgi.service.log.Logger> L getLogger(Class<?> clazz, Class<L> loggerType) {
return getLogger(null, clazz.getName(), loggerType);
}
@Override
public <L extends org.osgi.service.log.Logger> L getLogger(Bundle bundle, String name, Class<L> loggerType) {
return getLogger(bundle, name, loggerType, PaxLoggerImpl.FQCN);
}
private <L extends org.osgi.service.log.Logger> L getLogger(Bundle bundle, String name, Class<L> loggerType, String fqcn) {
if (loggerType == org.osgi.service.log.Logger.class) {
return loggerType.cast(getLogger(bundle, name, fqcn, false));
} else if (loggerType == org.osgi.service.log.FormatterLogger.class) {
return loggerType.cast(getLogger(bundle, name, fqcn, true));
}
throw new IllegalArgumentException("Can't obtain logger with type " + loggerType);
}
/**
* The only method that creates new instance of {@link PaxLoggerImpl}. Used by log() methods from R6 and directly
* by getLogger() methods from R7.
* @param bundle
* @param category
* @param fqcn
* @param printfFormatting whether to use Slf4J ({@code "{}"} - {@code false}) or printf formatting ({@code "%s"} - {@code true}).
* @return
*/
private PaxLogger getLogger(Bundle bundle, String category, String fqcn, boolean printfFormatting) {
// obtain org.apache.log4j.Logger from unshaded and unchanged log4j:log4j class.
// pax-logging-api uses shaded org.apache.log4j.Logger class, but here we need real
// implementation
Logger log4jLogger;
if (category == null) {
// Anonymous Logger in JDK Util Logging will have a category of null.
log4jLogger = Logger.getRootLogger();
} else {
log4jLogger = Logger.getLogger(category);
}
return new PaxLoggerImpl(bundle, log4jLogger, fqcn, this, printfFormatting);
}
/**
* When there's system/context property specified using {@link PaxLoggingConstants#LOGGING_CFG_PROPERTY_FILE},
* and ConfigurationAdmin is available, Pax Logging may first get null configuration. When "default configuration"
* is set before that, we'll use it instead of empty configuration.
* @param config
*/
public void setDefaultConfiguration(Dictionary<String, String> config) {
this.defaultConfiguration = config;
}
/**
* ManagedService-like method but not requiring Configuration Admin
* @param configuration
*/
public void updated(Dictionary<String, ?> configuration) {
if (configuration == null && defaultConfiguration == null) {
// mind that there's no synchronization here
configureDefaults();
return;
}
if (configuration == null) {
configuration = defaultConfiguration;
}
Object useLocks = configuration.get(PaxLoggingConstants.PID_CFG_USE_LOCKS);
if (!"false".equalsIgnoreCase(String.valueOf(useLocks))) {
// do not use locks ONLY if the property is "false". Otherwise (or if not set at all), use the locks
if (m_configLock == null) {
m_configLock = new ReentrantReadWriteLock();
}
} else {
m_configLock = null;
}
Properties extracted = extractKeys(configuration);
lock(true);
Exception problem = null;
ClassLoader loader = null;
List<PaxAppenderProxy> proxies = null;
try {
loader = Thread.currentThread().getContextClassLoader();
Thread.currentThread().setContextClassLoader(getClass().getClassLoader());
// If the updated() method is called without any log4j properties,
// then keep the default/previous configuration.
if (extracted.size() == 0) {
configureDefaults();
return;
}
try {
LogManager.resetConfiguration();
PaxLoggingConfigurator configurator = new PaxLoggingConfigurator(m_bundleContext);
configurator.doConfigure(extracted, LogManager.getLoggerRepository());
proxies = configurator.getProxies();
emptyConfiguration.set(false);
} catch (Exception e) {
LogLog.error("Configuration problem: " + e.getMessage(), e);
problem = e;
}
} finally {
unlock(true);
Thread.currentThread().setContextClassLoader(loader);
}
// Avoid holding the configuration lock when starting proxies
// It could cause deadlock if opening the service trackers block on the log because
// the service itself wants to log anything
if (proxies != null) {
for (PaxAppenderProxy proxy : proxies) {
proxy.open();
}
}
setLevelToJavaLogging(configuration);
// do it outside of the lock
if (problem == null) {
m_configNotifier.configurationDone();
} else {
m_configNotifier.configurationError(problem);
}
}
/**
* Actual logging work is done here for R6 log methods.
* @param bundle
* @param level
* @param message
* @param exception
* @param fqcn
*/
@SuppressWarnings("deprecation")
private void logImpl(Bundle bundle, int level, String message, Throwable exception, String fqcn) {
String category = BackendSupport.category(bundle);
PaxLogger logger = getLogger(bundle, category, fqcn);
if (exception != null) {
if (level < LOG_ERROR) {
logger.audit(message, exception);
} else {
switch (level) {
case LOG_ERROR:
logger.error(message, exception);
break;
case LOG_WARNING:
logger.warn(message, exception);
break;
case LOG_INFO:
logger.info(message, exception);
break;
case LOG_DEBUG:
logger.debug(message, exception);
break;
default:
logger.trace(message, exception);
}
}
} else {
if (level < LOG_ERROR) {
logger.audit(message);
} else {
switch (level) {
case LOG_ERROR:
logger.error(message);
break;
case LOG_WARNING:
logger.warn(message);
break;
case LOG_INFO:
logger.info(message);
break;
case LOG_DEBUG:
logger.debug(message);
break;
default:
logger.trace(message);
}
}
}
}
void handleEvents(String name, Bundle bundle, ServiceReference<?> sr, LogLevel level, String message, Throwable exception) {
LogEntry entry = new LogEntryImpl(name, bundle, sr, level, message, exception);
m_logReader.fireEvent(entry);
// This should only be null for TestCases.
if (m_eventAdmin != null) {
m_eventAdmin.postEvent(bundle, level, entry, message, exception, sr, getPaxContext().getContext());
}
}
private Properties extractKeys(Dictionary<String, ?> configuration) {
Properties extracted = new Properties();
Enumeration<String> list = configuration.keys();
while (list.hasMoreElements()) {
Object obj = list.nextElement();
extractKey(extracted, configuration, obj);
}
return extracted;
}
private void extractKey(Properties extracted, Dictionary<String, ?> configuration, Object obj) {
String key = (String) obj;
Object value = configuration.get(obj);
if (key.startsWith("log4j")) {
extracted.put(key, value);
} else if (key.startsWith("pax.")) {
if (PaxLoggingConstants.PID_CFG_LOG_READER_SIZE_LEGACY.equals(key)
|| PaxLoggingConstants.PID_CFG_LOG_READER_SIZE.equals(key)) {
try {
m_logReader.setMaxEntries(Integer.parseInt((String) value));
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
/**
* Default configuration, when Configuration Admin is not (yet) available.
*/
void configureDefaults() {
if (!emptyConfiguration.compareAndSet(false, true)) {
m_configNotifier.configurationDone();
return;
}
try {
LogManager.resetConfiguration();
String levelName = BackendSupport.defaultLogLevel(m_bundleContext);
Level julLevel = BackendSupport.toJULLevel(levelName);
org.apache.log4j.Level log4j1Level = org.apache.log4j.Level.toLevel(levelName, org.apache.log4j.Level.DEBUG);
PaxLoggingConfigurator configurator = new PaxLoggingConfigurator(m_bundleContext);
Properties defaultProperties = new Properties();
defaultProperties.put("log4j.rootLogger", log4j1Level.toString() + ", A1");
defaultProperties.put("log4j.appender.A1", "org.apache.log4j.ConsoleAppender");
// "Time, Thread, Category, nested Context layout"
defaultProperties.put("log4j.appender.A1.layout", "org.apache.log4j.TTCCLayout");
// Extract System Properties prefixed with "pax.log4j", and drop the "pax." and include these
extractSystemProperties(defaultProperties);
configurator.doConfigure(defaultProperties, LogManager.getLoggerRepository());
final java.util.logging.Logger rootLogger = java.util.logging.Logger.getLogger("");
rootLogger.setLevel(julLevel);
m_configNotifier.configurationDone();
} catch (Exception e) {
LogLog.error("Configuration problem: " + e.getMessage(), e);
m_configNotifier.configurationError(e);
}
}
private void extractSystemProperties(Properties output) {
// ConcurrentModificationException friendly approach
Properties properties = System.getProperties();
for (String key : properties.stringPropertyNames()) {
if (key.startsWith("pax.log4j")) {
String value = properties.getProperty(key);
key = key.substring(4);
output.put(key, value);
}
}
}
// org.osgi.framework.ServiceFactory
/**
* Use local class to delegate calls to underlying instance while keeping bundle reference.
*
* We don't need anything special from bundle-scoped service ({@link ServiceFactory}) except the
* reference to client bundle.
*/
@Override
public Object getService(final Bundle bundle, ServiceRegistration registration) {
class ManagedPaxLoggingService implements PaxLoggingService {
private final String FQCN = ManagedPaxLoggingService.class.getName();
@Override
public void log(int level, String message) {
PaxLoggingServiceImpl.this.logImpl(bundle, level, message, null, FQCN);
}
@Override
public void log(int level, String message, Throwable exception) {
PaxLoggingServiceImpl.this.logImpl(bundle, level, message, exception, FQCN);
}
@Override
public void log(ServiceReference sr, int level, String message) {
PaxLoggingServiceImpl.this.logImpl(bundle, level, message, null, FQCN);
}
@Override
public void log(ServiceReference sr, int level, String message, Throwable exception) {
PaxLoggingServiceImpl.this.logImpl(bundle, level, message, exception, FQCN);
}
@Override
public LogLevel getLogLevel() {
return PaxLoggingServiceImpl.this.getLogLevel();
}
@Override
public PaxLogger getLogger(Bundle myBundle, String category, String fqcn) {
return PaxLoggingServiceImpl.this.getLogger(myBundle, category, fqcn);
}
@Override
public PaxContext getPaxContext() {
return PaxLoggingServiceImpl.this.getPaxContext();
}
@Override
public org.osgi.service.log.Logger getLogger(String name) {
return PaxLoggingServiceImpl.this.getLogger(bundle, name, PaxLoggerImpl.FQCN);
}
@Override
public org.osgi.service.log.Logger getLogger(Class<?> clazz) {
return PaxLoggingServiceImpl.this.getLogger(bundle, clazz.getName(), PaxLoggerImpl.FQCN);
}
@Override
public <L extends org.osgi.service.log.Logger> L getLogger(String name, Class<L> loggerType) {
return PaxLoggingServiceImpl.this.getLogger(bundle, name, loggerType, PaxLoggerImpl.FQCN);
}
@Override
public <L extends org.osgi.service.log.Logger> L getLogger(Class<?> clazz, Class<L> loggerType) {
return PaxLoggingServiceImpl.this.getLogger(bundle, clazz.getName(), loggerType, PaxLoggerImpl.FQCN);
}
@Override
public <L extends org.osgi.service.log.Logger> L getLogger(Bundle bundle, String name, Class<L> loggerType) {
return PaxLoggingServiceImpl.this.getLogger(bundle, name, loggerType, PaxLoggerImpl.FQCN);
}
}
return new ManagedPaxLoggingService();
}
@Override
public void ungetService(Bundle bundle, ServiceRegistration registration, Object service) {
// nothing to do...
}
/**
* Configure Java Util Logging according to the provided configuration.
* Convert the log4j configuration to JUL config.
*
* It's necessary to do that, because with pax logging, JUL loggers are not replaced.
* So we need to configure JUL loggers in order that log messages goes correctly to log Handlers.
*
* @param configuration Properties coming from the configuration.
*/
private static void setLevelToJavaLogging(final Dictionary<String, ?> configuration) {
for (Enumeration<String> enum_ = java.util.logging.LogManager.getLogManager().getLoggerNames(); enum_.hasMoreElements(); ) {
String name = enum_.nextElement();
java.util.logging.Logger.getLogger(name).setLevel(null);
}
for (Enumeration<String> keys = configuration.keys(); keys.hasMoreElements(); ) {
String name = keys.nextElement();
String value = (String) configuration.get(name);
if (name.equals("log4j.rootLogger")) {
setJULLevel(java.util.logging.Logger.getGlobal(), value);
setJULLevel(java.util.logging.Logger.getLogger(""), value);
// "global" comes from java.util.logging.Logger.GLOBAL_LOGGER_NAME, but that constant wasn't added until Java 1.6
setJULLevel(java.util.logging.Logger.getLogger("global"), value);
}
if (name.startsWith("log4j.logger.")) {
String packageName = name.substring("log4j.logger.".length());
java.util.logging.Logger logger = java.util.logging.Logger.getLogger(packageName);
setJULLevel(logger, value);
}
}
}
/**
* Set the log level to the specified JUL logger.
*
* @param logger The logger to configure
* @param log4jLevelConfig The value contained in the property file. (For example: "ERROR, file")
*/
private static void setJULLevel(java.util.logging.Logger logger, String log4jLevelConfig) {
String[] crumb = log4jLevelConfig.split("\\s*,\\s*");
if (crumb.length > 0) {
Level level = BackendSupport.toJULLevel(crumb[0].trim());
logger.setLevel(level);
}
}
}