/
Log4jConfig.groovy
544 lines (457 loc) · 16.3 KB
/
Log4jConfig.groovy
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
/*
* Copyright 2004-2005 the original author or authors.
*
* 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.codehaus.groovy.grails.plugins.log4j
import grails.util.BuildSettings
import grails.util.BuildSettingsHolder
import grails.util.Environment
import grails.util.Metadata
import groovy.transform.CompileStatic
import org.apache.log4j.Appender
import org.apache.log4j.ConsoleAppender
import org.apache.log4j.FileAppender
import org.apache.log4j.HTMLLayout
import org.apache.log4j.Level
import org.apache.log4j.LogManager
import org.apache.log4j.Logger
import org.apache.log4j.PatternLayout
import org.apache.log4j.PropertyConfigurator
import org.apache.log4j.RollingFileAppender
import org.apache.log4j.SimpleLayout
import org.apache.log4j.helpers.LogLog
import org.apache.log4j.jdbc.JDBCAppender
import org.apache.log4j.varia.NullAppender
import org.apache.log4j.xml.XMLLayout
import org.codehaus.groovy.grails.plugins.log4j.appenders.GrailsConsoleAppender
/**
* Encapsulates the configuration of Log4j.
*
* @author Graeme Rocher
* @since 1.1
*/
class Log4jConfig {
static final PatternLayout DEFAULT_PATTERN_LAYOUT = new PatternLayout(
conversionPattern: '%d [%t] %-5p %c{2} %x - %m%n')
static final LAYOUTS = [xml: XMLLayout, html: HTMLLayout, simple: SimpleLayout, pattern: PatternLayout]
static final APPENDERS = [jdbc: JDBCAppender, "null": NullAppender, console: ConsoleAppender,
file: FileAppender, rollingFile: RollingFileAppender]
private Map appenders = [:]
private ConfigObject config
Log4jConfig(ConfigObject config) {
this.config = config
}
@CompileStatic
static void initialize(ConfigObject config) {
if (config == null) {
return
}
Object o = config.get("log4j")
Log4jConfig log4jConfig = new Log4jConfig(config)
LogManager.resetConfiguration()
if (o instanceof Closure) {
log4jConfig.configure((Closure<?>)o)
}
else if (o instanceof Map) {
log4jConfig.configure((Map<?, ?>)o)
}
else if (o instanceof Collection) {
log4jConfig.configure((Collection<?>)o)
}
else {
// setup default logging
log4jConfig.configure()
}
}
@CompileStatic
static void initialiseDefaultLog4jConfiguration() {
def defaultLog4j = new Properties()
defaultLog4j."log4j.rootLogger"="error, stdout"
defaultLog4j."log4j.appender.stdout"="org.apache.log4j.ConsoleAppender"
defaultLog4j."log4j.appender.stdout.layout"="org.apache.log4j.PatternLayout"
PropertyConfigurator.configure(defaultLog4j)
}
def propertyMissing(String name) {
if (LAYOUTS.containsKey(name)) {
return LAYOUTS[name].newInstance()
}
LogLog.error "Property missing when configuring log4j: $name"
throw new MissingPropertyException("Property missing when configuring log4j: $name")
}
def methodMissing(String name, args) {
if (APPENDERS.containsKey(name) && args) {
def constructorArgs = args[0] instanceof Map ? args[0] : [:]
if (!constructorArgs.layout) {
constructorArgs.layout = DEFAULT_PATTERN_LAYOUT
}
def appender = APPENDERS[name].newInstance()
populate appender, constructorArgs
if (!appender.name) {
LogLog.error "Appender of type $name doesn't define a name attribute, and hence is ignored."
}
else {
appenders[appender.name] = appender
}
appender.activateOptions()
return appender
}
if (LAYOUTS.containsKey(name) && args) {
return LAYOUTS[name].newInstance(args[0])
}
if (isCustomEnvironmentMethod(name, args)) {
return invokeCallable(args[0])
}
LogLog.error "Method missing when configuring log4j: $name"
}
@CompileStatic
void populate(Appender appender, Map args) {
final metaClass = GroovySystem.getMetaClassRegistry().getMetaClass(appender.getClass())
for(key in args.keySet()) {
final value = args.get(key)
String prop = key.toString()
if (appender.hasProperty(prop)) {
try {
metaClass.setProperty(appender, prop, value)
} catch (MissingPropertyException mpe) {
// ignore
}
}
}
}
private boolean isCustomEnvironmentMethod(String name, args) {
Environment.current == Environment.CUSTOM &&
Environment.current.name == name &&
args && (args[0] instanceof Closure)
}
def configure() {
configure {}
}
@CompileStatic
def environments(Closure callable) {
callable.delegate = new EnvironmentsLog4JConfig(this)
callable.resolveStrategy = Closure.DELEGATE_FIRST
callable.call()
}
@CompileStatic
def invokeCallable(Closure callable) {
callable.delegate = this
callable.resolveStrategy = Closure.DELEGATE_FIRST
callable.call()
}
/**
* Configure Log4J from a map whose values are DSL closures. This simply
* calls the closures in the order they come out of the map's iterator.
* This is to allow configuration like:
* <pre>
* log4j.main = {
* // main Log4J configuration in Config.groovy
* }
*
* log4j.extra = {
* // additional Log4J configuration in an external config file
* }
* </pre>
* In this situation, <code>config.log4j</code> is a ConfigObject, which is
* an extension of LinkedHashMap, and thus returns its sub-keys in order of
* definition.
*/
def configure(Map callables) {
configure(callables.values())
}
/**
* Configure Log4J from a <i>collection</i> of DSL closures by calling the
* closures one after another in sequence.
*/
def configure(Collection callables) {
return configure { root ->
for (c in callables) {
c.delegate = delegate
c.resolveStrategy = resolveStrategy
c.call(root)
}
}
}
def configure(Closure callable) {
Logger root = Logger.getRootLogger()
def consoleAppender = createConsoleAppender()
root.setLevel Level.ERROR
appenders['stdout'] = consoleAppender
error 'org.springframework',
'org.hibernate'
callable.delegate = this
callable.resolveStrategy = Closure.DELEGATE_FIRST
try {
callable.call(root)
if (!root.allAppenders.hasMoreElements()) {
root.addAppender appenders['stdout']
}
Logger logger = Logger.getLogger("StackTrace")
logger.additivity = false
def fileAppender = createFullstackTraceAppender()
if (fileAppender && !logger.allAppenders.hasMoreElements()) {
logger.addAppender fileAppender
}
}
catch (Exception e) {
LogLog.error "WARNING: Exception occured configuring log4j logging: $e.message"
}
}
@CompileStatic
private createConsoleAppender() {
def consoleAppender = Environment.isWarDeployed() ?
new ConsoleAppender() :
new GrailsConsoleAppender(config)
consoleAppender.layout = DEFAULT_PATTERN_LAYOUT
consoleAppender.name = "stdout"
consoleAppender.activateOptions()
appenders.console = consoleAppender
return consoleAppender
}
private createFullstackTraceAppender() {
if (appenders.stacktrace) {
return appenders.stacktrace
}
def fileAppender = new FileAppender(layout:DEFAULT_PATTERN_LAYOUT, name:"stacktraceLog")
BuildSettings settings = BuildSettingsHolder.getSettings()
def targetDir = settings?.getProjectTargetDir()
targetDir?.mkdirs()
if (!targetDir && Environment.isWarDeployed()) {
final tomcatHome = System.getProperty('catalina.home')
final applicationName = Metadata.getCurrent().getApplicationName() ?: 'grails'
targetDir = new File('.')
if (tomcatHome) {
targetDir = new File(tomcatHome, 'logs')
if (!targetDir.exists()) {
targetDir = new File(System.getProperty("java.io.tmpdir"))
}
}
else {
targetDir = new File(System.getProperty("java.io.tmpdir"))
}
}
final targetFile = targetDir ? new File(targetDir,"stacktrace.log") : new File("stacktrace.log")
fileAppender.file = targetFile.absolutePath
try {
fileAppender.activateOptions()
appenders.stacktrace = fileAppender
return fileAppender
} catch (FileNotFoundException e) {
LogLog.error("""WARNING: Unable to create the full stacktrace logger. The target file [$targetFile] is not writeable. Consider reconfiguring the stacktrace logger. Example:
log4j = {
appenders {
console name:'stacktrace'
}
}
""")
}
}
@CompileStatic
Logger root(Closure c) {
def root = Logger.getRootLogger()
if (c) {
c.delegate = new RootLog4jConfig(root, this)
c.resolveStrategy = Closure.DELEGATE_FIRST
c.call()
}
return root
}
@CompileStatic
def appenders(Closure callable) {
callable.delegate = this
callable.resolveStrategy = Closure.DELEGATE_FIRST
callable.call()
}
def appender(Map name, Appender instance) {
if (name && instance) {
String appenderName = name.values().iterator().next()
instance.name = appenderName
appenders[appenderName] = instance
instance.activateOptions()
}
}
def appender(Appender instance) {
if (instance && instance.name) {
appenders[instance.name] = instance
instance.activateOptions()
}
else {
LogLog.error "Appender [$instance] is null or does not define a name."
}
}
def off(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.OFF)
}
def fatal(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.FATAL)
}
def error(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.ERROR)
}
def warn(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.WARN)
}
def info(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.INFO)
}
def debug(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.DEBUG)
}
def trace(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.TRACE)
}
def all(Map appenderAndPackages) {
setLogLevelForAppenderToPackageMap(appenderAndPackages, Level.ALL)
}
private setLogLevelForAppenderToPackageMap(appenderAndPackages, Level level) {
def additivity = appenderAndPackages.additivity != null ? appenderAndPackages.remove('additivity') : true
appenderAndPackages?.each { appender, packages ->
eachLogger(packages) { Logger logger ->
logger.level = level
if (appenders[appender]) {
logger.addAppender appenders[appender]
logger.additivity = additivity
}
else {
LogLog.error "Appender $appender not found configuring logger ${logger.getName()}"
}
}
}
}
def eachLogger(packages, Closure callable) {
if (packages instanceof String || packages instanceof GString) {
Logger logger = Logger.getLogger(packages)
callable(logger)
}
else {
for (p in packages) {
p = p?.toString()
if (p) {
Logger logger = Logger.getLogger(p)
callable(logger)
}
}
}
}
def off(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.OFF }
}
def fatal(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.FATAL }
}
def error(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.ERROR }
}
def warn(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.WARN }
}
def info(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.INFO }
}
def debug(Object[] packages) {
eachLogger(packages) { Logger logger -> logger.level = Level.DEBUG }
}
def trace(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.TRACE }
}
def all(Object[] packages) {
eachLogger(packages) { logger -> logger.level = Level.ALL }
}
def removeAppender(String name) {
Logger.getRootLogger().removeAppender name
}
}
class RootLog4jConfig {
Logger root
Log4jConfig config
RootLog4jConfig(root, config) {
this.root = root
this.config = config
}
def debug(Object[] appenders = null) {
setLevelAndAppender(Level.DEBUG, appenders)
}
private setLevelAndAppender(Level level, Object[] appenders) {
root.level = level
for (appName in appenders) {
Appender app
if (appName instanceof Appender) {
app = appName
}
else {
app = config.appenders[appName?.toString()]
}
if (app) {
root.addAppender app
}
}
}
def info(Object[] appenders = null) {
setLevelAndAppender(Level.INFO, appenders)
}
def warn(Object[] appenders = null) {
setLevelAndAppender(Level.WARN, appenders)
}
def trace(Object[] appenders = null) {
setLevelAndAppender(Level.TRACE, appenders)
}
def all(Object[] appenders = null) {
setLevelAndAppender(Level.ALL, appenders)
}
def error(Object[] appenders = null) {
setLevelAndAppender(Level.ERROR, appenders)
}
def fatal(Object[] appenders = null) {
setLevelAndAppender(Level.FATAL, appenders)
}
def off(Object[] appenders = null) {
setLevelAndAppender(Level.OFF, appenders)
}
void setProperty(String s, o) {
root."$s" = o
}
}
class EnvironmentsLog4JConfig {
Log4jConfig config
EnvironmentsLog4JConfig(Log4jConfig config) {
this.config = config
}
def development(Closure callable) {
if (Environment.current == Environment.DEVELOPMENT) {
config.invokeCallable(callable)
}
}
def production(Closure callable) {
if (Environment.current == Environment.PRODUCTION) {
config.invokeCallable(callable)
}
}
def test(Closure callable) {
if (Environment.current == Environment.TEST) {
config.invokeCallable(callable)
}
}
def methodMissing(String name, args) {
if (args && args[0] instanceof Closure) {
// treat all method calls that take a closure as custom environment
// names
if (Environment.current == Environment.CUSTOM &&
Environment.current.name == name) {
config.invokeCallable(args[0])
}
}
else {
LogLog.error "Method missing when configuring log4j: $name"
}
}
}