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
|
package de.lmu.ifi.dbs.elki.logging;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2011
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.utilities.optionhandling.WrongParameterValueException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.StringParameter;
/**
* This final class contains some static convenience methods for logging.
*
* {@link #logExpensive} allows the programmer to easily emit a log message,
* however the function is rather expensive and thus should not be used within
* loop constructs.
*
* @author Erich Schubert
*
* @apiviz.uses ELKILogRecord oneway - - «create»
*/
public final class LoggingUtil {
/**
* Expensive logging function that is convenient, but should only be used in
* rare conditions.
*
* For 'frequent' logging, use more efficient techniques, such as explained in
* the {@link de.lmu.ifi.dbs.elki.logging logging package documentation}.
*
* @param level Logging level
* @param message Message to log.
* @param e Exception to report.
*/
public final static void logExpensive(Level level, String message, Throwable e) {
String[] caller = inferCaller();
if(caller != null) {
Logger logger = Logger.getLogger(caller[0]);
logger.logp(level, caller[0], caller[1], message, e);
}
else {
Logger.getAnonymousLogger().log(level, message, e);
}
}
/**
* Expensive logging function that is convenient, but should only be used in
* rare conditions.
*
* For 'frequent' logging, use more efficient techniques, such as explained in
* the {@link de.lmu.ifi.dbs.elki.logging logging package documentation}.
*
* @param level Logging level
* @param message Message to log.
*/
public final static void logExpensive(Level level, String message) {
LogRecord rec = new ELKILogRecord(level, message);
String[] caller = inferCaller();
if(caller != null) {
rec.setSourceClassName(caller[0]);
rec.setSourceMethodName(caller[1]);
Logger logger = Logger.getLogger(caller[0]);
logger.log(rec);
}
else {
Logger.getAnonymousLogger().log(rec);
}
}
/**
* Static version to log a severe exception.
*
* @param e Exception to log
*/
public final static void exception(Throwable e) {
logExpensive(Level.SEVERE, e.getMessage(), e);
}
/**
* Static version to log a severe exception.
*
* @param message Exception message, may be null (defaults to e.getMessage())
* @param e causing exception
*/
public final static void exception(String message, Throwable e) {
if(message == null && e != null) {
message = e.getMessage();
}
logExpensive(Level.SEVERE, message, e);
}
/**
* Static version to log a warning message.
*
* @param message Warning message.
*/
public final static void warning(String message) {
logExpensive(Level.WARNING, message);
}
/**
* Static version to log a warning message.
*
* @param message Warning message, may be null (defaults to e.getMessage())
* @param e causing exception
*/
public final static void warning(String message, Throwable e) {
if(message == null && e != null) {
message = e.getMessage();
}
logExpensive(Level.WARNING, message, e);
}
/**
* Static version to log a 'info' message.
*
* @param message Warning message.
*/
public final static void message(String message) {
logExpensive(Level.INFO, message);
}
/**
* Static version to log a 'info' message.
*
* @param message Warning message, may be null (defaults to e.getMessage())
* @param e causing exception
*/
public final static void message(String message, Throwable e) {
if(message == null && e != null) {
message = e.getMessage();
}
logExpensive(Level.INFO, message, e);
}
/**
* Infer which class has called the logging helper.
*
* While this looks like duplicated code from ELKILogRecord, it is needed here
* to find an appropriate Logger (and check the logging level) for the calling
* class, not just to log the right class and method name.
*
* @return calling class name and calling method name
*/
private final static String[] inferCaller() {
StackTraceElement stack[] = (new Throwable()).getStackTrace();
int ix = 0;
while(ix < stack.length) {
StackTraceElement frame = stack[ix];
if(!frame.getClassName().equals(LoggingUtil.class.getCanonicalName())) {
return new String[] { frame.getClassName(), frame.getMethodName() };
}
ix++;
}
return null;
}
/**
* Parse the option string to configure logging.
*
* @param param Parameter to process.
*
* @throws WrongParameterValueException On parsing errors
*/
public static final void parseDebugParameter(StringParameter param) throws WrongParameterValueException {
String[] opts = param.getValue().split(",");
for(String opt : opts) {
try {
String[] chunks = opt.split("=");
if(chunks.length == 1) {
try {
Level level = Level.parse(chunks[0]);
LoggingConfiguration.setDefaultLevel(level);
}
catch(IllegalArgumentException e) {
LoggingConfiguration.setLevelFor(chunks[0], Level.FINEST.getName());
}
}
else if(chunks.length == 2) {
LoggingConfiguration.setLevelFor(chunks[0], chunks[1]);
}
else {
throw new WrongParameterValueException(param, param.getValue(), "More than one '=' in debug parameter.");
}
}
catch(IllegalArgumentException e) {
throw (new WrongParameterValueException(param, param.getValue(), "Could not process value.", e));
}
}
}
}
|
