-
Notifications
You must be signed in to change notification settings - Fork 214
/
RequestTracingDirective.java
274 lines (244 loc) · 11.1 KB
/
RequestTracingDirective.java
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/*
* Copyright (c) 2021 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.gateway.service.endpoints.directives;
import static org.apache.pekko.http.javadsl.server.Directives.extractRequest;
import static org.apache.pekko.http.javadsl.server.Directives.mapRequest;
import static org.apache.pekko.http.javadsl.server.Directives.mapRouteResult;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.net.URI;
import java.text.MessageFormat;
import java.util.Map;
import java.util.Set;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.common.HttpStatus;
import org.eclipse.ditto.base.model.common.HttpStatusCodeOutOfRangeException;
import org.eclipse.ditto.base.model.headers.DittoHeaderDefinition;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoLogger;
import org.eclipse.ditto.internal.utils.pekko.logging.DittoLoggerFactory;
import org.eclipse.ditto.internal.utils.tracing.DittoTracing;
import org.eclipse.ditto.internal.utils.tracing.TraceInformationGenerator;
import org.eclipse.ditto.internal.utils.tracing.span.SpanOperationName;
import org.eclipse.ditto.internal.utils.tracing.span.SpanTagKey;
import org.eclipse.ditto.internal.utils.tracing.span.StartedSpan;
import org.apache.pekko.http.javadsl.model.HttpHeader;
import org.apache.pekko.http.javadsl.model.HttpRequest;
import org.apache.pekko.http.javadsl.model.HttpResponse;
import org.apache.pekko.http.javadsl.model.Uri;
import org.apache.pekko.http.javadsl.server.Complete;
import org.apache.pekko.http.javadsl.server.Route;
import org.apache.pekko.http.javadsl.server.RouteResult;
/**
* Custom Akka Http directive tracing the request.
*/
@Immutable
public final class RequestTracingDirective {
private static final DittoLogger LOGGER = DittoLoggerFactory.getLogger(RequestTracingDirective.class);
private RequestTracingDirective() {
throw new AssertionError();
}
/**
* Conditionally starts and finishes a new trace for every request.
* If the resolved span operation name is contained in the known disabled span operation names then the inner
* Route will be returned as is.
*
* @param innerRouteSupplier supplies the inner Route to be traced.
* @param correlationId the correlation ID which will be added to the log or {@code null} if no correlation ID
* should be added.
* @return the new Route wrapping {@code inner} with tracing.
* @throws NullPointerException if {@code inner} is {@code null}.
*/
public static Route traceRequest(final Supplier<Route> innerRouteSupplier,
@Nullable final CharSequence correlationId) {
checkNotNull(innerRouteSupplier, "innerRouteSupplier");
return extractRequest(request -> {
final Route result;
@Nullable final var operationName = tryToResolveSpanOperationName(request, correlationId);
if (null == operationName) {
result = innerRouteSupplier.get();
} else {
result = getRouteWithEnabledTracing(
startTrace(getHttpHeadersAsMap(request.getHeaders()), operationName, correlationId),
request,
innerRouteSupplier,
correlationId
);
}
return result;
});
}
@Nullable // internally working with null to avoid creating many Optionals
private static SpanOperationName tryToResolveSpanOperationName(
final HttpRequest httpRequest,
@Nullable final CharSequence correlationId
) {
try {
return resolveSpanOperationName(httpRequest);
} catch (final IllegalArgumentException e) {
LOGGER.withCorrelationId(correlationId).warn("Failed to resolve span operation name: {}", e.getMessage());
return null;
}
}
private static SpanOperationName resolveSpanOperationName(final HttpRequest httpRequest) {
return SpanOperationName.of(
MessageFormat.format("{0} {1}", getRequestMethodName(httpRequest), getTraceUri(httpRequest))
);
}
private static URI getTraceUri(final HttpRequest httpRequest) {
final var traceInformationGenerator = TraceInformationGenerator.getInstance();
final var traceInformation = traceInformationGenerator.apply(String.valueOf(getRelativeUri(httpRequest)));
return traceInformation.getTraceUri();
}
private static Uri getRelativeUri(final HttpRequest httpRequest) {
final var uri = httpRequest.getUri();
return uri.toRelative();
}
private static String getRequestMethodName(final HttpRequest httpRequest) {
final var httpMethod = httpRequest.method();
return httpMethod.name();
}
private static Map<String, String> getHttpHeadersAsMap(final Iterable<HttpHeader> httpHeaders) {
return StreamSupport.stream(httpHeaders.spliterator(), false)
.collect(Collectors.toMap(HttpHeader::name, HttpHeader::value, (oldValue, value) -> value));
}
private static StartedSpan startTrace(
final Map<String, String> headersMap,
final SpanOperationName traceOperationName,
@Nullable final CharSequence correlationId
) {
return DittoTracing.newPreparedSpan(headersMap, traceOperationName)
.correlationId(correlationId)
.start();
}
private static Route getRouteWithEnabledTracing(
final StartedSpan startedSpan,
final HttpRequest httpRequest,
final Supplier<Route> innerRouteSupplier,
@Nullable final CharSequence correlationId
) {
return mapRequest(
req -> adjustSpanContextHeadersOfRequest(req, startedSpan.propagateContext(Map.of())),
() -> mapRouteResult(
routeResult -> tryToHandleRouteResult(routeResult, httpRequest, startedSpan, correlationId),
innerRouteSupplier
)
);
}
private static HttpRequest adjustSpanContextHeadersOfRequest(
final HttpRequest originalRequest,
final Map<String, String> spanContextHeaders
) {
// Replace W3C tracing headers of original request because from now
// on the newly started span is the parent of all subsequent spans.
var result = originalRequest;
for (final var w3cTracingHeader : getW3cTracingHeaders(spanContextHeaders)) {
result = result.removeHeader(w3cTracingHeader.name()).addHeader(w3cTracingHeader);
}
return result;
}
private static Set<HttpHeader> getW3cTracingHeaders(final Map<String, String> spanContextHeaders) {
return Stream.of(DittoHeaderDefinition.W3C_TRACEPARENT, DittoHeaderDefinition.W3C_TRACESTATE)
.map(DittoHeaderDefinition::getKey)
.filter(spanContextHeaders::containsKey)
.map(w3cTracingHeaderName -> HttpHeader.parse(
w3cTracingHeaderName,
spanContextHeaders.get(w3cTracingHeaderName)
))
.collect(Collectors.toSet());
}
@Nullable
private static RouteResult tryToHandleRouteResult(
@Nullable final RouteResult routeResult,
final HttpRequest httpRequest,
final StartedSpan startedSpan,
@Nullable final CharSequence correlationId
) {
try {
handleRouteResult(routeResult, httpRequest, startedSpan, correlationId);
} catch (final Exception e) {
startedSpan.tagAsFailed(e);
} finally {
startedSpan.finish();
}
return routeResult;
}
private static void handleRouteResult(
@Nullable final RouteResult routeResult,
final HttpRequest httpRequest,
final StartedSpan startedSpan,
@Nullable final CharSequence correlationId
) {
if (routeResult instanceof Complete complete) {
addRequestResponseTags(startedSpan, httpRequest, complete.getResponse(), correlationId);
} else if (null != routeResult) {
startedSpan.tagAsFailed("Request rejected: " + routeResult.getClass().getName());
} else {
startedSpan.tagAsFailed("Request failed.");
}
}
private static void addRequestResponseTags(
final StartedSpan startedSpan,
final HttpRequest httpRequest,
final HttpResponse httpResponse,
@Nullable final CharSequence correlationId
) {
startedSpan.tag(SpanTagKey.REQUEST_METHOD_NAME.getTagForValue(getRequestMethodName(httpRequest)));
@Nullable final var relativeRequestUri = tryToGetRelativeRequestUri(httpRequest, correlationId);
if (null != relativeRequestUri) {
startedSpan.tag(SpanTagKey.REQUEST_URI.getTagForValue(relativeRequestUri));
}
@Nullable final var httpStatus = tryToGetResponseHttpStatus(httpResponse, correlationId);
if (null != httpStatus) {
startedSpan.tag(SpanTagKey.HTTP_STATUS.getTagForValue(httpStatus));
}
}
@Nullable
private static URI tryToGetRelativeRequestUri(
final HttpRequest httpRequest,
@Nullable final CharSequence correlationId
) {
try {
return getRelativeRequestUri(httpRequest);
} catch (final IllegalArgumentException e) {
LOGGER.withCorrelationId(correlationId)
.info("Failed to get {} for HTTP response: {}", URI.class.getSimpleName(), e.getMessage());
return null;
}
}
private static URI getRelativeRequestUri(final HttpRequest httpRequest) {
final var filteredRelativeRequestUri = RequestLoggingFilter.filterUri(getRelativeUri(httpRequest));
return URI.create(filteredRelativeRequestUri.getPathString());
}
@Nullable
private static HttpStatus tryToGetResponseHttpStatus(
final HttpResponse httpResponse,
@Nullable final CharSequence correlationId
) {
try {
return getResponseHttpStatus(httpResponse);
} catch (final HttpStatusCodeOutOfRangeException e) {
LOGGER.withCorrelationId(correlationId)
.info("Failed to get {} for HTTP response: {}", HttpStatus.class.getSimpleName(), e.getMessage());
return null;
}
}
private static HttpStatus getResponseHttpStatus(final HttpResponse httpResponse)
throws HttpStatusCodeOutOfRangeException {
final var statusCode = httpResponse.status();
return HttpStatus.getInstance(statusCode.intValue());
}
}