Skip to content

Set Event.http.request.url on a best effort basis - 2 #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 11, 2021
Merged

Set Event.http.request.url on a best effort basis - 2 #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac63dd0
1. Update HttpFieldsGenerator#maybeSetHttpUrlForOtelFormat to overwri…
Jan 8, 2021
ece101e
Merge branch 'main' into populate-http-url-option-2
Jan 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion ...nerator/src/main/java/org/hypertrace/viewgenerator/generators/SpanEventViewGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import org.apache.avro.Schema;
import org.hypertrace.core.datamodel.Entity;
import org.hypertrace.core.datamodel.Event;
import org.hypertrace.core.datamodel.MetricValue;
import org.hypertrace.core.datamodel.StructuredTrace;
import org.hypertrace.core.datamodel.eventfields.http.Http;
import org.hypertrace.core.datamodel.eventfields.http.Request;
import org.hypertrace.core.datamodel.shared.SpanAttributeUtils;
import org.hypertrace.traceenricher.enrichedspan.constants.EnrichedSpanConstants;
import org.hypertrace.traceenricher.enrichedspan.constants.utils.EnrichedSpanUtils;
Expand Down Expand Up @@ -292,7 +295,9 @@ String getRequestUrl(Event event, Protocol protocol) {
switch (protocol) {
case PROTOCOL_HTTP:
case PROTOCOL_HTTPS:
return EnrichedSpanUtils.getFullHttpUrl(event).orElse(event.getHttp().getRequest().getPath());
return EnrichedSpanUtils.getFullHttpUrl(event).orElse(
Optional.ofNullable(event.getHttp()).map(Http::getRequest).map(Request::getPath)
.orElse(null));
case PROTOCOL_GRPC:
return event.getEventName();
}
Expand Down
25 changes: 25 additions & 0 deletions ...tor/src/test/java/org/hypertrace/viewgenerator/generators/SpanEventViewGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,29 @@ public void test_getRequestUrl_grpcProctol_shouldReturnEventName() {
spanEventViewGenerator.getRequestUrl(event, Protocol.PROTOCOL_GRPC)
);
}

@Test
public void testGetRequestUrl_fullUrlIsAbsent() {
Event event = mock(Event.class);
when(event.getHttp()).thenReturn(Http.newBuilder()
.setRequest(Request.newBuilder()
.setPath("/api/v1/gatekeeper/check")
.build()
).build()
);
Assertions.assertEquals(
"/api/v1/gatekeeper/check",
spanEventViewGenerator.getRequestUrl(event, Protocol.PROTOCOL_HTTP));
}

@Test
public void testGetRequestUrl_urlAndPathIsAbsent() {
Event event = mock(Event.class);
when(event.getHttp()).thenReturn(Http.newBuilder()
.setRequest(Request.newBuilder()
.build()
).build()
);
Assertions.assertNull(spanEventViewGenerator.getRequestUrl(event, Protocol.PROTOCOL_HTTP));
}
}
20 changes: 17 additions & 3 deletions ...src/main/java/org/hypertrace/core/spannormalizer/fieldgenerators/HttpFieldsGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ private static void setUserAgent(
.ifPresent(userAgent -> httpBuilder.getRequestBuilder().setUserAgent(userAgent));
}

private static void setPath(
static void setPath(
Http.Builder httpBuilder, Map<String, JaegerSpanInternalModel.KeyValue> tagsMap) {
if (httpBuilder.getRequestBuilder().hasPath()) {
return;
Expand All @@ -469,7 +469,7 @@ private static String removeTrailingSlash(String s) {
return s.endsWith(SLASH) && s.length() > 1 ? s.substring(0, s.length() - 1) : s;
}

private static Optional<String> getPathFromUrlObject(String urlPath) {
static Optional<String> getPathFromUrlObject(String urlPath) {
try {
URL url = getNormalizedUrl(urlPath);
return Optional.of(url.getPath());
Expand Down Expand Up @@ -569,13 +569,27 @@ private static URL getNormalizedUrl(String url) throws MalformedURLException {
return new URL(new URL(RELATIVE_URL_CONTEXT), url);
}

/**
* If the requestBuilder already has absolute url, do nothing
* if not, try building url based on otel attributes and overwrite
*/
private void maybeSetHttpUrlForOtelFormat(
Request.Builder requestBuilder,
final Map<String, AttributeValue> attributeValueMap) {
if (requestBuilder.hasUrl()) {
if (requestBuilder.hasUrl() && isAbsoluteUrl(requestBuilder.getUrl())) {
return;
}
Optional<String> url = HttpSemanticConventionUtils.getHttpUrlForOTelFormat(attributeValueMap);
url.ifPresent(requestBuilder::setUrl);
}

static boolean isAbsoluteUrl(String urlStr) {
try {
URL url = getNormalizedUrl(urlStr);
return url.toString().equals(urlStr);
} catch (MalformedURLException e) {
Copy link
Contributor

@tim-mwangi tim-mwangi Jan 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add unit tests for these negative scenarios?(If possible)

Copy link
Contributor Author

@findingrish findingrish Jan 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The java implementation for URL conversion seems to be able to parse all the strings! I will update the test, when I find one.

// ignore
}
return false;
}
}
41 changes: 40 additions & 1 deletion ...test/java/org/hypertrace/core/spannormalizer/fieldgenerators/HttpFieldsGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
import static org.hypertrace.core.span.constants.v1.OTSpanTag.OT_SPAN_TAG_HTTP_URL;
import static org.hypertrace.core.spannormalizer.utils.TestUtils.createKeyValue;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import com.google.common.collect.Maps;
import io.jaegertracing.api_v2.JaegerSpanInternalModel;
Expand All @@ -46,9 +48,12 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import org.hypertrace.core.datamodel.AttributeValue;
import org.hypertrace.core.datamodel.Event;
import org.hypertrace.core.datamodel.eventfields.http.Http;
import org.hypertrace.core.datamodel.eventfields.http.Request;
import org.hypertrace.core.semantic.convention.constants.span.OTelSpanSemanticConventions;
import org.hypertrace.core.span.constants.RawSpanConstants;
import org.hypertrace.core.semantic.convention.constants.http.OTelHttpSemanticConventions;
import org.junit.jupiter.api.Assertions;
Expand Down Expand Up @@ -836,7 +841,6 @@ public void testPopulateOtherFieldsOTelSpan() {
eventBuilder = Event.newBuilder();
eventBuilder.getHttpBuilder().getRequestBuilder().setUrl("/apis/5673/events?a1=v1&a2=v2");
map = Maps.newHashMap();
map.put(OTelHttpSemanticConventions.HTTP_URL.getValue(), buildAttributeValue(url));
httpFieldsGenerator.populateOtherFields(eventBuilder, map);

Assertions.assertNull(eventBuilder.getHttpBuilder().getRequestBuilder().getUrl());
Expand Down Expand Up @@ -876,6 +880,41 @@ public void testPopulateOtherFieldsOTelSpan() {
"/some-test-path", eventBuilder.getHttpBuilder().getRequestBuilder().getPath());
assertEquals(
"some-query-str=v1", eventBuilder.getHttpBuilder().getRequestBuilder().getQueryString());

// originally set url is a relative url, should be overridden
eventBuilder = Event.newBuilder();
eventBuilder.getHttpBuilder().getRequestBuilder().setUrl("/api/v1/gatekeeper/check?url=%2Fpixel%2Factivities%3Fadvertisable%3DTRHRT&method=GET&service=pixel");
map = Maps.newHashMap();
map.put(OTelHttpSemanticConventions.HTTP_SCHEME.getValue(), buildAttributeValue("http"));
map.put(OTelSpanSemanticConventions.SPAN_KIND.getValue(), buildAttributeValue("server"));
map.put(OTelHttpSemanticConventions.HTTP_NET_HOST_NAME.getValue(), buildAttributeValue("example.internal.com"));
map.put(OTelHttpSemanticConventions.HTTP_NET_HOST_PORT.getValue(), buildAttributeValue("50850"));
map.put(OTelHttpSemanticConventions.HTTP_TARGET.getValue(), buildAttributeValue("/api/v1/gatekeeper/check?url=%2Fpixel%2Factivities%3Fadvertisable%3DTRHRT&method=GET&service=pixel"));
httpFieldsGenerator.populateOtherFields(eventBuilder, map);
assertEquals("http://example.internal.com:50850/api/v1/gatekeeper/check?url=%2Fpixel%2Factivities%3Fadvertisable%3DTRHRT&method=GET&service=pixel", eventBuilder.getHttpBuilder().getRequestBuilder().getUrl());
}

@Test
public void testIsAbsoluteUrl() {
assertTrue(HttpFieldsGenerator.isAbsoluteUrl("http://example.com/abc/xyz"));
assertFalse(HttpFieldsGenerator.isAbsoluteUrl("/abc/xyz"));
}

@Test
public void testGetPathFromUrl() {
Optional<String> path = HttpFieldsGenerator.getPathFromUrlObject(
"/api/v1/gatekeeper/check?url=%2Fpixel%2Factivities%3Fadvertisable%3DTRHRT&method=GET&service=pixel");
assertEquals(path.get(), "/api/v1/gatekeeper/check");
}

@Test
public void testSetPath() {
Map<String, JaegerSpanInternalModel.KeyValue> tagsMap = new HashMap<>();
tagsMap.put(OTelHttpSemanticConventions.HTTP_TARGET.getValue(),
createKeyValue("/api/v1/gatekeeper/check?url=%2Fpixel%2Factivities%3Fadvertisable%3DTRHRT&method=GET&service=pixel"));
Http.Builder builder = Http.newBuilder().setRequestBuilder(Request.newBuilder());
HttpFieldsGenerator.setPath(builder, tagsMap);
assertEquals(builder.getRequestBuilder().getPath(), "/api/v1/gatekeeper/check");
}

private static AttributeValue buildAttributeValue(String value) {
Expand Down