48083
|
1 |
/*
|
49765
|
2 |
* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
|
48083
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
4 |
*
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
|
10 |
*
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
15 |
* accompanied this code).
|
|
16 |
*
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
20 |
*
|
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
|
23 |
* questions.
|
|
24 |
*/
|
49765
|
25 |
|
|
26 |
package jdk.internal.net.http.common;
|
48083
|
27 |
|
|
28 |
import java.io.PrintStream;
|
|
29 |
import java.util.Objects;
|
|
30 |
import java.util.ResourceBundle;
|
|
31 |
import java.util.function.Supplier;
|
|
32 |
|
|
33 |
/**
|
|
34 |
* A {@code System.Logger} that forwards all messages to an underlying
|
49765
|
35 |
* {@code System.Logger}, after adding some decoration. The logger also has the
|
|
36 |
* ability to additionally send the logged messages to System.err or System.out,
|
|
37 |
* whether the underlying logger is activated or not. In addition instance of
|
|
38 |
* {@code DebugLogger} support both {@link String#format(String, Object...)} and
|
48083
|
39 |
* {@link java.text.MessageFormat#format(String, Object...)} formatting.
|
49765
|
40 |
* String-like formatting is enabled by the presence of "%s" or "%d" in the
|
|
41 |
* format string. MessageFormat-like formatting is enabled by the presence of
|
|
42 |
* "{0" or "{1".
|
|
43 |
*
|
|
44 |
* <p> See {@link Utils#getDebugLogger(Supplier, boolean)} and
|
48083
|
45 |
* {@link Utils#getHpackLogger(Supplier, boolean)}.
|
|
46 |
*/
|
49765
|
47 |
final class DebugLogger implements Logger {
|
48083
|
48 |
// deliberately not in the same subtree than standard loggers.
|
|
49 |
final static String HTTP_NAME = "jdk.internal.httpclient.debug";
|
49765
|
50 |
final static String WS_NAME = "jdk.internal.httpclient.websocket.debug";
|
48083
|
51 |
final static String HPACK_NAME = "jdk.internal.httpclient.hpack.debug";
|
49765
|
52 |
final static System.Logger HTTP = System.getLogger(HTTP_NAME);
|
|
53 |
final static System.Logger WS = System.getLogger(WS_NAME);
|
|
54 |
final static System.Logger HPACK = System.getLogger(HPACK_NAME);
|
49944
|
55 |
private static final DebugLogger NO_HTTP_LOGGER =
|
|
56 |
new DebugLogger(HTTP, "HTTP"::toString, Level.OFF, Level.OFF);
|
|
57 |
private static final DebugLogger NO_WS_LOGGER =
|
|
58 |
new DebugLogger(HTTP, "WS"::toString, Level.OFF, Level.OFF);
|
|
59 |
private static final DebugLogger NO_HPACK_LOGGER =
|
|
60 |
new DebugLogger(HTTP, "HPACK"::toString, Level.OFF, Level.OFF);
|
48083
|
61 |
final static long START_NANOS = System.nanoTime();
|
|
62 |
|
|
63 |
private final Supplier<String> dbgTag;
|
|
64 |
private final Level errLevel;
|
|
65 |
private final Level outLevel;
|
49765
|
66 |
private final System.Logger logger;
|
48083
|
67 |
private final boolean debugOn;
|
|
68 |
private final boolean traceOn;
|
|
69 |
|
|
70 |
/**
|
|
71 |
* Create a logger for debug traces.The logger should only be used
|
|
72 |
* with levels whose severity is {@code <= DEBUG}.
|
|
73 |
*
|
|
74 |
* By default, this logger will forward all messages logged to the supplied
|
|
75 |
* {@code logger}.
|
|
76 |
* But in addition, if the message severity level is {@code >=} to
|
|
77 |
* the provided {@code errLevel} it will print the messages on System.err,
|
|
78 |
* and if the message severity level is {@code >=} to
|
|
79 |
* the provided {@code outLevel} it will also print the messages on System.out.
|
|
80 |
* <p>
|
|
81 |
* The logger will add some decoration to the printed message, in the form of
|
|
82 |
* {@code <Level>:[<thread-name>] [<elapsed-time>] <dbgTag>: <formatted message>}
|
|
83 |
*
|
|
84 |
* @apiNote To obtain a logger that will always print things on stderr in
|
|
85 |
* addition to forwarding to the internal logger, use
|
|
86 |
* {@code new DebugLogger(logger, this::dbgTag, Level.OFF, Level.ALL);}.
|
|
87 |
* To obtain a logger that will only forward to the internal logger,
|
|
88 |
* use {@code new DebugLogger(logger, this::dbgTag, Level.OFF, Level.OFF);}.
|
|
89 |
*
|
|
90 |
* @param logger The internal logger to which messages will be forwarded.
|
|
91 |
* This should be either {@link #HPACK} or {@link #HTTP};
|
|
92 |
*
|
|
93 |
* @param dbgTag A lambda that returns a string that identifies the caller
|
|
94 |
* (e.g: "SocketTube(3)", or "Http2Connection(SocketTube(3))")
|
|
95 |
* @param outLevel The level above which messages will be also printed on
|
|
96 |
* System.out (in addition to being forwarded to the internal logger).
|
|
97 |
* @param errLevel The level above which messages will be also printed on
|
|
98 |
* System.err (in addition to being forwarded to the internal logger).
|
|
99 |
*
|
|
100 |
* @return A logger for HTTP internal debug traces
|
|
101 |
*/
|
49765
|
102 |
private DebugLogger(System.Logger logger,
|
48083
|
103 |
Supplier<String> dbgTag,
|
|
104 |
Level outLevel,
|
|
105 |
Level errLevel) {
|
|
106 |
this.dbgTag = dbgTag;
|
|
107 |
this.errLevel = errLevel;
|
|
108 |
this.outLevel = outLevel;
|
|
109 |
this.logger = Objects.requireNonNull(logger);
|
|
110 |
// support only static configuration.
|
|
111 |
this.debugOn = isEnabled(Level.DEBUG);
|
|
112 |
this.traceOn = isEnabled(Level.TRACE);
|
|
113 |
}
|
|
114 |
|
|
115 |
@Override
|
|
116 |
public String getName() {
|
|
117 |
return logger.getName();
|
|
118 |
}
|
|
119 |
|
|
120 |
private boolean isEnabled(Level level) {
|
49944
|
121 |
return levelEnabledFor(level, outLevel, errLevel, logger);
|
|
122 |
}
|
|
123 |
|
|
124 |
@Override
|
|
125 |
public final boolean on() {
|
|
126 |
return debugOn;
|
|
127 |
}
|
|
128 |
|
|
129 |
static boolean levelEnabledFor(Level level, Level outLevel, Level errLevel,
|
|
130 |
System.Logger logger) {
|
48083
|
131 |
if (level == Level.OFF) return false;
|
|
132 |
int severity = level.getSeverity();
|
|
133 |
return severity >= errLevel.getSeverity()
|
|
134 |
|| severity >= outLevel.getSeverity()
|
|
135 |
|| logger.isLoggable(level);
|
|
136 |
}
|
|
137 |
|
|
138 |
@Override
|
|
139 |
public boolean isLoggable(Level level) {
|
|
140 |
// fast path, we assume these guys never change.
|
|
141 |
// support only static configuration.
|
|
142 |
if (level == Level.DEBUG) return debugOn;
|
|
143 |
if (level == Level.TRACE) return traceOn;
|
|
144 |
return isEnabled(level);
|
|
145 |
}
|
|
146 |
|
|
147 |
@Override
|
|
148 |
public void log(Level level, ResourceBundle unused,
|
|
149 |
String format, Object... params) {
|
|
150 |
// fast path, we assume these guys never change.
|
|
151 |
// support only static configuration.
|
|
152 |
if (level == Level.DEBUG && !debugOn) return;
|
|
153 |
if (level == Level.TRACE && !traceOn) return;
|
|
154 |
|
|
155 |
int severity = level.getSeverity();
|
|
156 |
if (errLevel != Level.OFF
|
|
157 |
&& errLevel.getSeverity() <= severity) {
|
|
158 |
print(System.err, level, format, params, null);
|
|
159 |
}
|
|
160 |
if (outLevel != Level.OFF
|
|
161 |
&& outLevel.getSeverity() <= severity) {
|
|
162 |
print(System.out, level, format, params, null);
|
|
163 |
}
|
|
164 |
if (logger.isLoggable(level)) {
|
|
165 |
logger.log(level, unused,
|
|
166 |
getFormat(new StringBuilder(), format, params).toString(),
|
|
167 |
params);
|
|
168 |
}
|
|
169 |
}
|
|
170 |
|
|
171 |
@Override
|
|
172 |
public void log(Level level, ResourceBundle unused, String msg,
|
|
173 |
Throwable thrown) {
|
|
174 |
// fast path, we assume these guys never change.
|
|
175 |
if (level == Level.DEBUG && !debugOn) return;
|
|
176 |
if (level == Level.TRACE && !traceOn) return;
|
|
177 |
|
|
178 |
if (errLevel != Level.OFF
|
|
179 |
&& errLevel.getSeverity() <= level.getSeverity()) {
|
|
180 |
print(System.err, level, msg, null, thrown);
|
|
181 |
}
|
|
182 |
if (outLevel != Level.OFF
|
|
183 |
&& outLevel.getSeverity() <= level.getSeverity()) {
|
|
184 |
print(System.out, level, msg, null, thrown);
|
|
185 |
}
|
|
186 |
if (logger.isLoggable(level)) {
|
|
187 |
logger.log(level, unused,
|
|
188 |
getFormat(new StringBuilder(), msg, null).toString(),
|
|
189 |
thrown);
|
|
190 |
}
|
|
191 |
}
|
|
192 |
|
|
193 |
private void print(PrintStream out, Level level, String msg,
|
|
194 |
Object[] params, Throwable t) {
|
|
195 |
StringBuilder sb = new StringBuilder();
|
|
196 |
sb.append(level.name()).append(':').append(' ');
|
|
197 |
sb = format(sb, msg, params);
|
|
198 |
if (t != null) sb.append(' ').append(t.toString());
|
|
199 |
out.println(sb.toString());
|
|
200 |
if (t != null) {
|
|
201 |
t.printStackTrace(out);
|
|
202 |
}
|
|
203 |
}
|
|
204 |
|
|
205 |
private StringBuilder decorate(StringBuilder sb, String msg) {
|
|
206 |
String tag = dbgTag == null ? null : dbgTag.get();
|
|
207 |
String res = msg == null ? "" : msg;
|
|
208 |
long elapsed = System.nanoTime() - START_NANOS;
|
|
209 |
long millis = elapsed / 1000_000;
|
|
210 |
long secs = millis / 1000;
|
|
211 |
sb.append('[').append(Thread.currentThread().getName()).append(']')
|
|
212 |
.append(' ').append('[');
|
|
213 |
if (secs > 0) {
|
|
214 |
sb.append(secs).append('s');
|
|
215 |
}
|
|
216 |
millis = millis % 1000;
|
|
217 |
if (millis > 0) {
|
|
218 |
if (secs > 0) sb.append(' ');
|
|
219 |
sb.append(millis).append("ms");
|
|
220 |
}
|
|
221 |
sb.append(']').append(' ');
|
|
222 |
if (tag != null) {
|
|
223 |
sb.append(tag).append(' ');
|
|
224 |
}
|
|
225 |
sb.append(res);
|
|
226 |
return sb;
|
|
227 |
}
|
|
228 |
|
|
229 |
|
|
230 |
private StringBuilder getFormat(StringBuilder sb, String format, Object[] params) {
|
|
231 |
if (format == null || params == null || params.length == 0) {
|
|
232 |
return decorate(sb, format);
|
|
233 |
} else if (format.contains("{0}") || format.contains("{1}")) {
|
|
234 |
return decorate(sb, format);
|
|
235 |
} else if (format.contains("%s") || format.contains("%d")) {
|
|
236 |
try {
|
|
237 |
return decorate(sb, String.format(format, params));
|
|
238 |
} catch (Throwable t) {
|
|
239 |
return decorate(sb, format);
|
|
240 |
}
|
|
241 |
} else {
|
|
242 |
return decorate(sb, format);
|
|
243 |
}
|
|
244 |
}
|
|
245 |
|
|
246 |
private StringBuilder format(StringBuilder sb, String format, Object[] params) {
|
|
247 |
if (format == null || params == null || params.length == 0) {
|
|
248 |
return decorate(sb, format);
|
|
249 |
} else if (format.contains("{0}") || format.contains("{1}")) {
|
|
250 |
return decorate(sb, java.text.MessageFormat.format(format, params));
|
|
251 |
} else if (format.contains("%s") || format.contains("%d")) {
|
|
252 |
try {
|
|
253 |
return decorate(sb, String.format(format, params));
|
|
254 |
} catch (Throwable t) {
|
|
255 |
return decorate(sb, format);
|
|
256 |
}
|
|
257 |
} else {
|
|
258 |
return decorate(sb, format);
|
|
259 |
}
|
|
260 |
}
|
|
261 |
|
49765
|
262 |
public static DebugLogger createHttpLogger(Supplier<String> dbgTag,
|
|
263 |
Level outLevel,
|
|
264 |
Level errLevel) {
|
49944
|
265 |
if (levelEnabledFor(Level.DEBUG, outLevel, errLevel, HTTP)) {
|
|
266 |
return new DebugLogger(HTTP, dbgTag, outLevel, errLevel);
|
|
267 |
} else {
|
|
268 |
// return a shared instance if debug logging is not enabled.
|
|
269 |
return NO_HTTP_LOGGER;
|
|
270 |
}
|
48083
|
271 |
}
|
|
272 |
|
49765
|
273 |
public static DebugLogger createWebSocketLogger(Supplier<String> dbgTag,
|
|
274 |
Level outLevel,
|
|
275 |
Level errLevel) {
|
49944
|
276 |
if (levelEnabledFor(Level.DEBUG, outLevel, errLevel, WS)) {
|
|
277 |
return new DebugLogger(WS, dbgTag, outLevel, errLevel);
|
|
278 |
} else {
|
|
279 |
// return a shared instance if logging is not enabled.
|
|
280 |
return NO_WS_LOGGER;
|
|
281 |
}
|
49765
|
282 |
}
|
|
283 |
|
|
284 |
public static DebugLogger createHpackLogger(Supplier<String> dbgTag,
|
|
285 |
Level outLevel,
|
|
286 |
Level errLevel) {
|
49944
|
287 |
if (levelEnabledFor(Level.DEBUG, outLevel, errLevel, HPACK)) {
|
|
288 |
return new DebugLogger(HPACK, dbgTag, outLevel, errLevel);
|
|
289 |
} else {
|
|
290 |
// return a shared instance if logging is not enabled.
|
|
291 |
return NO_HPACK_LOGGER;
|
|
292 |
}
|
48083
|
293 |
}
|
|
294 |
}
|