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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.http.server.jetty;
import com.google.common.base.Objects;
import com.yahoo.container.logging.AccessLog;
import com.yahoo.container.logging.AccessLogEntry;
import com.yahoo.container.logging.RequestLog;
import com.yahoo.container.logging.RequestLogEntry;
import com.yahoo.jdisc.http.HttpRequest;
import org.eclipse.jetty.http2.HTTP2Stream;
import org.eclipse.jetty.http2.server.HttpTransportOverHTTP2;
import org.eclipse.jetty.server.HttpChannel;
import org.eclipse.jetty.server.HttpTransport;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.Response;
import org.eclipse.jetty.util.component.AbstractLifeCycle;
import java.security.cert.X509Certificate;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.OptionalInt;
import java.util.UUID;
import java.util.function.BiConsumer;
import java.util.logging.Level;
import java.util.logging.Logger;
import static com.yahoo.jdisc.http.server.jetty.RequestUtils.getConnector;
import static com.yahoo.jdisc.http.server.jetty.RequestUtils.getConnectorLocalPort;
/**
* This class is a bridge between Jetty's {@link org.eclipse.jetty.server.handler.RequestLogHandler}
* and our own configurable access logging in different formats provided by {@link AccessLog}.
*
* @author Oyvind Bakksjo
* @author bjorncs
*/
class AccessLogRequestLog extends AbstractLifeCycle implements org.eclipse.jetty.server.RequestLog {
private static final Logger logger = Logger.getLogger(AccessLogRequestLog.class.getName());
// HTTP headers that are logged as extra key-value-pairs in access log entries
private static final List<String> LOGGED_REQUEST_HEADERS = List.of("Vespa-Client-Version");
private final RequestLog requestLog;
AccessLogRequestLog(RequestLog requestLog) {
this.requestLog = requestLog;
}
@Override
public void log(Request request, Response response) {
try {
RequestLogEntry.Builder builder = new RequestLogEntry.Builder();
String peerAddress = request.getRemoteAddr();
int peerPort = request.getRemotePort();
long startTime = request.getTimeStamp();
long endTime = System.currentTimeMillis();
builder.peerAddress(peerAddress)
.peerPort(peerPort)
.localPort(getLocalPort(request))
.timestamp(Instant.ofEpochMilli(startTime))
.duration(Duration.ofMillis(Math.max(0, endTime - startTime)))
.responseSize(response.getHttpChannel().getBytesWritten())
.requestSize(request.getHttpInput().getContentReceived())
.statusCode(response.getCommittedMetaData().getStatus());
addNonNullValue(builder, request.getMethod(), RequestLogEntry.Builder::httpMethod);
addNonNullValue(builder, request.getRequestURI(), RequestLogEntry.Builder::rawPath);
addNonNullValue(builder, request.getProtocol(), RequestLogEntry.Builder::httpVersion);
addNonNullValue(builder, request.getScheme(), RequestLogEntry.Builder::scheme);
addNonNullValue(builder, request.getHeader("User-Agent"), RequestLogEntry.Builder::userAgent);
addNonNullValue(builder, getServerName(request), RequestLogEntry.Builder::hostString);
addNonNullValue(builder, request.getHeader("Referer"), RequestLogEntry.Builder::referer);
addNonNullValue(builder, request.getQueryString(), RequestLogEntry.Builder::rawQuery);
HttpRequest jdiscRequest = (HttpRequest) request.getAttribute(HttpRequest.class.getName());
if (jdiscRequest != null) {
addNonNullValue(builder, jdiscRequest.getUserPrincipal(), RequestLogEntry.Builder::userPrincipal);
}
String requestFilterId = (String) request.getAttribute(RequestUtils.JDISC_REQUEST_CHAIN);
addNonNullValue(builder, requestFilterId, (b, chain) -> b.addExtraAttribute("request-chain", chain));
String responseFilterId = (String) request.getAttribute(RequestUtils.JDISC_RESPONSE_CHAIN);
addNonNullValue(builder, responseFilterId, (b, chain) -> b.addExtraAttribute("response-chain", chain));
UUID connectionId = (UUID) request.getAttribute(JettyConnectionLogger.CONNECTION_ID_REQUEST_ATTRIBUTE);
addNonNullValue(builder, connectionId, (b, uuid) -> b.connectionId(uuid.toString()));
String remoteAddress = getRemoteAddress(request);
if (!Objects.equal(remoteAddress, peerAddress)) {
builder.remoteAddress(remoteAddress);
}
int remotePort = getRemotePort(request);
if (remotePort != peerPort) {
builder.remotePort(remotePort);
}
LOGGED_REQUEST_HEADERS.forEach(header -> {
String value = request.getHeader(header);
if (value != null) {
builder.addExtraAttribute(header, value);
}
});
X509Certificate[] clientCert = (X509Certificate[]) request.getAttribute(RequestUtils.SERVLET_REQUEST_X509CERT);
if (clientCert != null && clientCert.length > 0) {
builder.sslPrincipal(clientCert[0].getSubjectX500Principal());
}
AccessLogEntry accessLogEntry = (AccessLogEntry) request.getAttribute(JDiscHttpServlet.ATTRIBUTE_NAME_ACCESS_LOG_ENTRY);
if (accessLogEntry != null) {
var extraAttributes = accessLogEntry.getKeyValues();
if (extraAttributes != null) {
extraAttributes.forEach(builder::addExtraAttributes);
}
addNonNullValue(builder, accessLogEntry.getHitCounts(), RequestLogEntry.Builder::hitCounts);
addNonNullValue(builder, accessLogEntry.getTrace(), RequestLogEntry.Builder::traceNode);
}
http2StreamId(request).ifPresent(streamId -> builder.addExtraAttribute("http2-stream-id", Integer.toString(streamId)));
requestLog.log(builder.build());
} catch (Exception e) {
// Catching any exceptions here as it is unclear how Jetty handles exceptions from a RequestLog.
logger.log(Level.SEVERE, "Failed to log access log entry: " + e.getMessage(), e);
}
}
private static String getServerName(Request request) {
try {
return request.getServerName();
} catch (IllegalArgumentException e) {
/*
* getServerName() may throw IllegalArgumentException for invalid requests where request line contains a URI with relative path.
* Jetty correctly responds with '400 Bad Request' prior to invoking our request log implementation.
*/
logger.log(Level.FINE, e, () -> "Fallback to 'Host' header");
return request.getHeader("Host");
}
}
private String getRemoteAddress(Request request) {
for (String header : getConnector(request).connectorConfig().accessLog().remoteAddressHeaders()) {
String value = request.getHeader(header);
if (value != null) return value;
}
return request.getRemoteAddr();
}
private int getRemotePort(Request request) {
for (String header : getConnector(request).connectorConfig().accessLog().remotePortHeaders()) {
String value = request.getHeader(header);
if (value != null) {
OptionalInt maybePort = parsePort(value);
if (maybePort.isPresent()) return maybePort.getAsInt();
}
}
return request.getRemotePort();
}
private static int getLocalPort(Request request) {
int connectorLocalPort = getConnectorLocalPort(request);
if (connectorLocalPort <= 0) return request.getLocalPort(); // If connector is already closed
return connectorLocalPort;
}
private static OptionalInt parsePort(String port) {
try {
return OptionalInt.of(Integer.parseInt(port));
} catch (IllegalArgumentException e) {
return OptionalInt.empty();
}
}
private static OptionalInt http2StreamId(Request request) {
HttpChannel httpChannel = request.getHttpChannel();
if (httpChannel == null) return OptionalInt.empty();
HttpTransport transport = httpChannel.getHttpTransport();
if (!(transport instanceof HttpTransportOverHTTP2)) return OptionalInt.empty();
HTTP2Stream stream = (HTTP2Stream) ((HttpTransportOverHTTP2) transport).getStream();
return OptionalInt.of(stream.getId());
}
private static <T> void addNonNullValue(
RequestLogEntry.Builder builder, T value, BiConsumer<RequestLogEntry.Builder, T> setter) {
if (value != null) {
setter.accept(builder, value);
}
}
}
|
