Skip to content
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

Make HttpClientMetrics report low cardinality metrics #5319

Merged
merged 1 commit into from
Feb 8, 2022
Merged

Make HttpClientMetrics report low cardinality metrics #5319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 4 additions & 23 deletions ...ain/java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ private static Set<AttributeKey> buildDurationAlwaysInclude() {
private static Set<AttributeKey> buildDurationClientView() {
// We pull identifying attributes according to:
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/http-metrics.md#attribute-alternatives
// We only pull net.peer.name and net.peer.port because http.url has too high cardinality
Set<AttributeKey> view = new HashSet<>(durationAlwaysInclude);
view.add(SemanticAttributes.HTTP_URL);
view.add(SemanticAttributes.NET_PEER_NAME);
view.add(SemanticAttributes.NET_PEER_PORT);
return view;
}

Expand Down Expand Up @@ -93,31 +95,10 @@ private static void applyView(
(BiConsumer<AttributeKey, Object>)
(key, value) -> {
if (view.contains(key)) {
// For now, we filter query parameters out of URLs in metrics.
if (SemanticAttributes.HTTP_URL.equals(key)
|| SemanticAttributes.HTTP_TARGET.equals(key)) {
filtered.put(key, removeQueryParamFromUrlOrTarget(value.toString()));
} else {
filtered.put(key, value);
}
filtered.put(key, value);
}
});
}

// Attempt to handle cleaning URLs like http://myServer;jsessionId=1 or targets like
// /my/path?queryParam=2
private static String removeQueryParamFromUrlOrTarget(String urlOrTarget) {
// Note: Maybe not the most robust, but purely to limit cardinality.
int idx = -1;
for (int i = 0; i < urlOrTarget.length(); ++i) {
char ch = urlOrTarget.charAt(i);
if (ch == '?' || ch == ';') {
idx = i;
break;
}
}
return idx == -1 ? urlOrTarget : urlOrTarget.substring(0, idx);
}

private TemporaryMetricsView() {}
}
8 changes: 5 additions & 3 deletions ...st/java/io/opentelemetry/instrumentation/api/instrumenter/http/HttpClientMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ void collectsMetrics() {
.put("http.host", "host")
.put("http.target", "/")
.put("http.scheme", "https")
.put("net.host.name", "localhost")
.put("net.host.port", 1234)
.put("net.peer.name", "localhost")
.put("net.peer.ip", "0.0.0.0")
.put("net.peer.port", 1234)
.build();

Attributes responseAttributes =
Expand Down Expand Up @@ -87,7 +88,8 @@ void collectsMetrics() {
.hasSum(150 /* millis */)
.attributes()
.containsOnly(
attributeEntry("http.url", "https://localhost:1234/"),
attributeEntry("net.peer.name", "localhost"),
attributeEntry("net.peer.port", 1234),
attributeEntry("http.method", "GET"),
attributeEntry("http.flavor", "2.0"),
attributeEntry("http.status_code", 200));
Expand Down
39 changes: 6 additions & 33 deletions ...java/io/opentelemetry/instrumentation/api/instrumenter/http/TemporaryMetricsViewTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,10 @@
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
import org.junit.jupiter.api.Test;

public class TemporaryMetricsViewTest {
class TemporaryMetricsViewTest {

@Test
public void shouldApplyClientDurationView_urlIdentity() {
Attributes startAttributes =
Attributes.builder()
.put(SemanticAttributes.HTTP_URL, "https://somehost/high/cardinality/12345")
.put(SemanticAttributes.HTTP_SCHEME, "https")
.put(SemanticAttributes.HTTP_METHOD, "GET")
.put(SemanticAttributes.HTTP_HOST, "somehost")
.put(SemanticAttributes.HTTP_TARGET, "/high/cardinality/12345")
.build();

Attributes endAttributes =
Attributes.builder()
.put(SemanticAttributes.HTTP_STATUS_CODE, 500)
.put(SemanticAttributes.NET_PEER_NAME, "somehost2")
.put(SemanticAttributes.NET_PEER_IP, "127.0.0.1")
.put(SemanticAttributes.NET_PEER_PORT, 443)
.build();

OpenTelemetryAssertions.assertThat(applyClientDurationView(startAttributes, endAttributes))
.containsOnly(
attributeEntry(
SemanticAttributes.HTTP_URL.getKey(), "https://somehost/high/cardinality/12345"),
attributeEntry(SemanticAttributes.HTTP_METHOD.getKey(), "GET"),
attributeEntry(SemanticAttributes.HTTP_STATUS_CODE.getKey(), 500));
}

@Test
public void shouldApplyClientDurationView_urlWithQuery() {
void shouldApplyClientDurationView() {
Attributes startAttributes =
Attributes.builder()
.put(
Expand All @@ -67,14 +40,14 @@ public void shouldApplyClientDurationView_urlWithQuery() {

OpenTelemetryAssertions.assertThat(applyClientDurationView(startAttributes, endAttributes))
.containsOnly(
attributeEntry(
SemanticAttributes.HTTP_URL.getKey(), "https://somehost/high/cardinality/12345"),
attributeEntry(SemanticAttributes.NET_PEER_NAME.getKey(), "somehost2"),
attributeEntry(SemanticAttributes.NET_PEER_PORT.getKey(), 443),
attributeEntry(SemanticAttributes.HTTP_METHOD.getKey(), "GET"),
attributeEntry(SemanticAttributes.HTTP_STATUS_CODE.getKey(), 500));
}

@Test
public void shouldApplyServerDurationView_withRoute() {
void shouldApplyServerDurationView() {
Attributes startAttributes =
Attributes.builder()
.put(SemanticAttributes.HTTP_METHOD, "GET")
Expand Down Expand Up @@ -110,7 +83,7 @@ public void shouldApplyServerDurationView_withRoute() {
}

@Test
public void shouldApplyActiveRequestsView() {
void shouldApplyActiveRequestsView() {
Attributes attributes =
Attributes.builder()
.put(SemanticAttributes.HTTP_METHOD, "GET")
Expand Down