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
|
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.io.File;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.util.Properties;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogManager;
import java.util.logging.Logger;
import de.lmu.ifi.dbs.elki.utilities.FileUtil;
/**
* Facility for configuration of logging.
*
* @author Erich Schubert
*/
public final class LoggingConfiguration {
/**
* General debug flag.
*/
public static boolean DEBUG = false;
/**
* Configuration file name
*/
private static final String CLIConffile = "logging-cli.properties";
/**
* Top level ELKI package (for setting 'verbose')
*/
private static final String TOPLEVEL_PACKAGE = "de.lmu.ifi.dbs.elki";
/**
* Configuration base
*/
private static final String confbase = LoggingConfiguration.class.getPackage().getName();
/**
* Static instance of the configuration
*/
protected static LoggingConfiguration config = new LoggingConfiguration(confbase, CLIConffile);
/**
* Configure Java Logging API: {@link java.util.logging.LogManager}
*/
private LoggingConfiguration(final String pkg, final String name) {
privateReconfigureLogging(pkg, name);
}
/**
* Reconfigure logging.
*
* @param pkg Package name the configuration file comes from
* @param name File name.
*/
public static void reconfigureLogging(final String pkg, final String name) {
config.privateReconfigureLogging(pkg, name);
}
/**
* Reconfigure logging.
*
* @param pkg Package name the configuration file comes from
* @param name File name.
*/
private void privateReconfigureLogging(String pkg, final String name) {
LogManager logManager = LogManager.getLogManager();
Logger logger = Logger.getLogger(LoggingConfiguration.class.getName());
// allow null as package name.
if(pkg == null) {
pkg = "";
}
// Load logging configuration from resources.
String cfgfile = pkg.replace('.', File.separatorChar) + File.separatorChar + name;
try {
InputStream cfgdata = FileUtil.openSystemFile(cfgfile);
logManager.readConfiguration(cfgdata);
// also load as properties for us, to get debug flag.
InputStream cfgdata2 = FileUtil.openSystemFile(cfgfile);
Properties cfgprop = new Properties();
cfgprop.load(cfgdata2);
DEBUG = Boolean.valueOf(cfgprop.getProperty("debug"));
logger.info("Logging configuration read.");
}
catch(FileNotFoundException e) {
logger.log(Level.SEVERE, "Could not find logging configuration file: " + cfgfile, e);
}
catch(Exception e) {
logger.log(Level.SEVERE, "Failed to configure logging from file: " + cfgfile, e);
}
}
/**
* Assert that logging was configured.
*/
public static void assertConfigured() {
// nothing happening here, just to ensure static construction was run.
}
/**
* Reconfigure logging to enable 'verbose' logging at the top level.
*
* @param verbose verbose flag
*/
public static void setVerbose(boolean verbose) {
Logger logger1 = Logger.getLogger("");
Logger logger2 = Logger.getLogger(TOPLEVEL_PACKAGE);
if(verbose) {
// decrease to INFO if it was higher
if(logger1.getLevel() == null || logger1.getLevel().intValue() > Level.INFO.intValue()) {
logger1.setLevel(Level.INFO);
}
if(logger2.getLevel() == null || logger2.getLevel().intValue() > Level.INFO.intValue()) {
logger2.setLevel(Level.INFO);
}
}
else {
// increase to warning level if it was INFO.
if(logger1.getLevel() != null || logger1.getLevel() == Level.INFO) {
logger1.setLevel(Level.WARNING);
}
if(logger2.getLevel() != null || logger2.getLevel() == Level.INFO) {
logger2.setLevel(Level.WARNING);
}
}
}
/**
* Add a handler to the root logger.
*
* @param handler Handler
*/
public static void addHandler(Handler handler) {
LogManager.getLogManager().getLogger("").addHandler(handler);
}
/**
* Replace the default log handler with the given log handler.
*
* This will remove all {@link CLISmartHandler} found on the root logger. It
* will leave any other handlers in place.
*
* @param handler Logging handler.
*/
public static void replaceDefaultHandler(Handler handler) {
Logger rootlogger = LogManager.getLogManager().getLogger("");
for(Handler h : rootlogger.getHandlers()) {
if(h instanceof CLISmartHandler) {
rootlogger.removeHandler(h);
}
}
addHandler(handler);
}
/**
* Set the logging level for a particular package/class.
*
* @param pkg Package
* @param level Level name
* @throws IllegalArgumentException thrown when logger or level was not found
*/
public static void setLevelFor(String pkg, String level) throws IllegalArgumentException {
Logger logr = Logger.getLogger(pkg);
if(logr == null) {
throw new IllegalArgumentException("Logger not found.");
}
// Can also throw an IllegalArgumentException
Level lev = Level.parse(level);
logr.setLevel(lev);
}
/**
* Set the default level.
*
* @param level level
*/
public static void setDefaultLevel(Level level) {
Logger.getLogger(TOPLEVEL_PACKAGE).setLevel(level);
}
}
|
