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
|
package de.lmu.ifi.dbs.elki.logging;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import de.lmu.ifi.dbs.elki.application.AbstractApplication;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.AbstractParameterization;
/**
* Base {@link LogRecord} class used in ELKI.
*
* In contrast to the 'original' LogRecord class, this class will ignore
* additional classes when determining the 'origin' of a log message.
*
* @author Erich Schubert
*/
public class ELKILogRecord extends LogRecord {
/**
* Serial Version UID
*/
private static final long serialVersionUID = 2820476270420700176L;
/**
* Flag whether we still need to infer the caller.
*/
private transient boolean needToInferCaller = false;
/**
* Classes to ignore when finding the relevant caller.
*/
public final static String[] IGNORE_CLASSES = { Logger.class.getCanonicalName(), Logging.class.getCanonicalName(), LoggingUtil.class.getCanonicalName(), ELKILogRecord.class.getCanonicalName(), AbstractParameterization.class.getCanonicalName(), AbstractApplication.class.getCanonicalName() };
/**
* Name of this class.
*/
private final static String START_TRACE_AT = Logger.class.getCanonicalName();
/**
* Constructor.
*
* @param level Message level
* @param msg Message contents.
*/
public ELKILogRecord(Level level, CharSequence msg) {
super(level, (msg != null) ? msg.toString() : null);
needToInferCaller = true;
}
/*
* use our inferCaller implementation.
*/
@Override
public String getSourceClassName() {
if(needToInferCaller) {
inferCallerELKI();
}
return super.getSourceClassName();
}
/*
* use our inferCaller implementation.
*/
@Override
public void setSourceClassName(String sourceClassName) {
super.setSourceClassName(sourceClassName);
needToInferCaller = false;
}
/*
* use our inferCaller implementation.
*/
@Override
public String getSourceMethodName() {
if(needToInferCaller) {
inferCallerELKI();
}
return super.getSourceMethodName();
}
/*
* use our inferCaller implementation.
*/
@Override
public void setSourceMethodName(String sourceMethodName) {
super.setSourceMethodName(sourceMethodName);
needToInferCaller = false;
}
/**
* Infer a caller, ignoring logging-related classes.
*/
private final void inferCallerELKI() {
needToInferCaller = false;
StackTraceElement stack[] = (new Throwable()).getStackTrace();
int ix = 0;
// skip back to the logger.
while(ix < stack.length) {
StackTraceElement frame = stack[ix];
final String cls = frame.getClassName();
if(cls.equals(START_TRACE_AT)) {
break;
}
ix++;
}
// skip further back through helper functions
while(ix < stack.length) {
StackTraceElement frame = stack[ix];
final String cls = frame.getClassName();
boolean ignore = false;
for(int i = 0; i < IGNORE_CLASSES.length; i++) {
if(cls.equals(IGNORE_CLASSES[i])) {
ignore = true;
break;
}
}
if(!ignore) {
super.setSourceClassName(frame.getClassName());
super.setSourceMethodName(frame.getMethodName());
break;
}
ix++;
}
}
}
|
