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

Jump to bottom

Remove Attributes combination from onEnd #11959

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Remove Attributes combination from onEnd #11959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
41b9c6e
fix-unit-test
wgy035 Sep 13, 2024
c07bfaa
Merge branch 'main' into instrumenter-metrics-optimize
wgy035 Sep 13, 2024
4b8311a
fix-format-violations
wgy035 Sep 14, 2024
5e04034
Merge branch 'instrumenter-metrics-optimize' of https://github.com/wg…
wgy035 Sep 14, 2024
dcb4798
fix-format-violations
wgy035 Sep 14, 2024
7cf6900
fix-format-violations
wgy035 Sep 14, 2024
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
4 changes: 1 addition & 3 deletions ...ain/java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcClientMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,7 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) {
return;
}
clientDurationHistogram.record(
(endNanos - state.startTimeNanos()) / NANOS_PER_MS,
state.startAttributes().toBuilder().putAll(endAttributes).build(),
context);
(endNanos - state.startTimeNanos()) / NANOS_PER_MS, endAttributes, context);
}

@AutoValue
Expand Down
9 changes: 4 additions & 5 deletions ...opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcCommonAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ abstract class RpcCommonAttributesExtractor<REQUEST, RESPONSE>
}

@Override
public final void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
internalSet(attributes, RPC_SYSTEM, getter.getSystem(request));
internalSet(attributes, RPC_SERVICE, getter.getService(request));
internalSet(attributes, RPC_METHOD, getter.getMethod(request));
}
public final void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {}

@Override
public final void onEnd(
Expand All @@ -42,5 +38,8 @@ public final void onEnd(
@Nullable RESPONSE response,
@Nullable Throwable error) {
// No response attributes
internalSet(attributes, RPC_SYSTEM, getter.getSystem(request));
internalSet(attributes, RPC_SERVICE, getter.getService(request));
internalSet(attributes, RPC_METHOD, getter.getMethod(request));
}
}
4 changes: 1 addition & 3 deletions ...ain/java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcServerMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,7 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) {
return;
}
serverDurationHistogram.record(
(endNanos - state.startTimeNanos()) / NANOS_PER_MS,
state.startAttributes().toBuilder().putAll(endAttributes).build(),
context);
(endNanos - state.startTimeNanos()) / NANOS_PER_MS, endAttributes, context);
}

@AutoValue
Expand Down
1 change: 1 addition & 0 deletions ...ion-api/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/Instrumenter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ private void doEnd(
if (operationListeners.length != 0) {
long endNanos = getNanos(endTime);
for (int i = operationListeners.length - 1; i >= 0; i--) {

Copy link
Contributor

Choose a reason for hiding this comment

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

The modification here is useless.

operationListeners[i].onEnd(context, attributes, endNanos);
}
}
Expand Down
18 changes: 8 additions & 10 deletions ...java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,6 @@ public static <REQUEST, RESPONSE> HttpClientAttributesExtractorBuilder<REQUEST,
@Override
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
super.onStart(attributes, parentContext, request);

internalServerExtractor.onStart(attributes, request);

String fullUrl = stripSensitiveData(getter.getUrlFull(request));
internalSet(attributes, UrlAttributes.URL_FULL, fullUrl);

int resendCount = resendCountIncrementer.applyAsInt(parentContext);
if (resendCount > 0) {
attributes.put(HttpAttributes.HTTP_REQUEST_RESEND_COUNT, resendCount);
}
}

@Override
Expand All @@ -90,7 +80,15 @@ public void onEnd(
@Nullable RESPONSE response,
@Nullable Throwable error) {
super.onEnd(attributes, context, request, response, error);
internalServerExtractor.onEnd(attributes, request);

String fullUrl = stripSensitiveData(getter.getUrlFull(request));
internalSet(attributes, UrlAttributes.URL_FULL, fullUrl);

int resendCount = resendCountIncrementer.applyAsInt(context);
if (resendCount > 0) {
attributes.put(HttpAttributes.HTTP_REQUEST_RESEND_COUNT, resendCount);
}
internalNetworkExtractor.onEnd(attributes, request, response);
}

Expand Down
4 changes: 1 addition & 3 deletions ...pi/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,7 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) {
return;
}

Attributes attributes = state.startAttributes().toBuilder().putAll(endAttributes).build();

duration.record((endNanos - state.startTimeNanos()) / NANOS_PER_S, attributes, context);
duration.record((endNanos - state.startTimeNanos()) / NANOS_PER_S, endAttributes, context);
}

@AutoValue
Expand Down
19 changes: 9 additions & 10 deletions ...java/io/opentelemetry/instrumentation/api/semconv/http/HttpCommonAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,15 @@ abstract class HttpCommonAttributesExtractor<
}

@Override
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {}

@Override
public void onEnd(
AttributesBuilder attributes,
Context context,
REQUEST request,
@Nullable RESPONSE response,
@Nullable Throwable error) {
String method = getter.getHttpRequestMethod(request);
if (method == null || knownMethods.contains(method)) {
internalSet(attributes, HttpAttributes.HTTP_REQUEST_METHOD, method);
Expand All @@ -72,15 +80,6 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST
internalSet(attributes, requestAttributeKey(name), values);
}
}
}

@Override
public void onEnd(
AttributesBuilder attributes,
Context context,
REQUEST request,
@Nullable RESPONSE response,
@Nullable Throwable error) {

Integer statusCode = null;
if (response != null) {
Expand Down
13 changes: 6 additions & 7 deletions ...java/io/opentelemetry/instrumentation/api/semconv/http/HttpServerAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,6 @@ public static <REQUEST, RESPONSE> HttpServerAttributesExtractorBuilder<REQUEST,
@Override
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
super.onStart(attributes, parentContext, request);
Copy link
Contributor

Choose a reason for hiding this comment

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

Only the attributes that are added at the start will be available for sampling. Moving all the attributes to the onEnd will make sampling impossible.

Copy link
Contributor Author

@wgy035 wgy035 Aug 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

So I need to figure out which attributes impact sampling, and those attributes are the minimum set need to retain, right?

According to semantic-conventions(e.g. http-spans), I'd like to extract the unique attributes of span at the start without needing to pass them on. The common attributes attributes should be extracted at the end.


internalUrlExtractor.onStart(attributes, request);
internalServerExtractor.onStart(attributes, request);
internalClientExtractor.onStart(attributes, request);

internalSet(attributes, HttpAttributes.HTTP_ROUTE, getter.getHttpRoute(request));
internalSet(attributes, UserAgentAttributes.USER_AGENT_ORIGINAL, userAgent(request));
}

@Override
Expand All @@ -94,7 +87,13 @@ public void onEnd(
@Nullable Throwable error) {

super.onEnd(attributes, context, request, response, error);
internalSet(attributes, UserAgentAttributes.USER_AGENT_ORIGINAL, userAgent(request));

internalUrlExtractor.onEnd(attributes, request);
internalServerExtractor.onEnd(attributes, request);
internalClientExtractor.onEnd(attributes, request);

internalSet(attributes, HttpAttributes.HTTP_ROUTE, getter.getHttpRoute(request));
internalNetworkExtractor.onEnd(attributes, request, response);

internalSet(attributes, HttpAttributes.HTTP_ROUTE, httpRouteGetter.apply(context));
Expand Down
4 changes: 1 addition & 3 deletions ...pi/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpServerMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,7 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) {
return;
}

Attributes attributes = state.startAttributes().toBuilder().putAll(endAttributes).build();

duration.record((endNanos - state.startTimeNanos()) / NANOS_PER_S, attributes, context);
duration.record((endNanos - state.startTimeNanos()) / NANOS_PER_S, endAttributes, context);
}

@AutoValue
Expand Down
8 changes: 4 additions & 4 deletions .../java/io/opentelemetry/instrumentation/api/semconv/network/ClientAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ public static <REQUEST, RESPONSE> ClientAttributesExtractor<REQUEST, RESPONSE> c
}

@Override
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
internalExtractor.onStart(attributes, request);
}
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {}

@Override
public void onEnd(
AttributesBuilder attributes,
Context context,
REQUEST request,
@Nullable RESPONSE response,
@Nullable Throwable error) {}
@Nullable Throwable error) {
internalExtractor.onEnd(attributes, request);
}
}
8 changes: 4 additions & 4 deletions .../java/io/opentelemetry/instrumentation/api/semconv/network/ServerAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ public static <REQUEST, RESPONSE> ServerAttributesExtractor<REQUEST, RESPONSE> c
}

@Override
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
internalExtractor.onStart(attributes, request);
}
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {}

@Override
public void onEnd(
AttributesBuilder attributes,
Context context,
REQUEST request,
@Nullable RESPONSE response,
@Nullable Throwable error) {}
@Nullable Throwable error) {
internalExtractor.onEnd(attributes, request);
}
}
2 changes: 1 addition & 1 deletion ...metry/instrumentation/api/semconv/network/internal/InternalClientAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public InternalClientAttributesExtractor(
this.capturePort = capturePort;
}

public void onStart(AttributesBuilder attributes, REQUEST request) {
public void onEnd(AttributesBuilder attributes, REQUEST request) {
AddressAndPort clientAddressAndPort = addressAndPortExtractor.extract(request);

if (clientAddressAndPort.address != null) {
Expand Down
2 changes: 1 addition & 1 deletion ...metry/instrumentation/api/semconv/network/internal/InternalServerAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public InternalServerAttributesExtractor(
this.addressAndPortExtractor = addressAndPortExtractor;
}

public void onStart(AttributesBuilder attributes, REQUEST request) {
public void onEnd(AttributesBuilder attributes, REQUEST request) {
AddressAndPort serverAddressAndPort = addressAndPortExtractor.extract(request);

if (serverAddressAndPort.address != null) {
Expand Down
8 changes: 4 additions & 4 deletions ...rc/main/java/io/opentelemetry/instrumentation/api/semconv/url/UrlAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ public static <REQUEST, RESPONSE> UrlAttributesExtractor<REQUEST, RESPONSE> crea
}

@Override
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
internalExtractor.onStart(attributes, request);
}
public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {}

@Override
public void onEnd(
AttributesBuilder attributes,
Context context,
REQUEST request,
@Nullable RESPONSE response,
@Nullable Throwable error) {}
@Nullable Throwable error) {
internalExtractor.onEnd(attributes, request);
}
}
2 changes: 1 addition & 1 deletion ...pentelemetry/instrumentation/api/semconv/url/internal/InternalUrlAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public InternalUrlAttributesExtractor(
this.alternateSchemeProvider = alternateSchemeProvider;
}

public void onStart(AttributesBuilder attributes, REQUEST request) {
public void onEnd(AttributesBuilder attributes, REQUEST request) {
String urlScheme = getUrlScheme(request);
String urlPath = getter.getUrlPath(request);
String urlQuery = getter.getUrlQuery(request);
Expand Down
60 changes: 27 additions & 33 deletions .../io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,28 +169,26 @@ void normal() {

AttributesBuilder startAttributes = Attributes.builder();
extractor.onStart(startAttributes, Context.root(), request);
assertThat(startAttributes.build())
.containsOnly(
entry(HttpAttributes.HTTP_REQUEST_METHOD, "POST"),
entry(UrlAttributes.URL_FULL, "http://github.com"),
entry(
AttributeKey.stringArrayKey("http.request.header.custom-request-header"),
asList("123", "456")),
entry(ServerAttributes.SERVER_ADDRESS, "github.com"),
entry(ServerAttributes.SERVER_PORT, 80L),
entry(HttpAttributes.HTTP_REQUEST_RESEND_COUNT, 2L));

AttributesBuilder endAttributes = Attributes.builder();
extractor.onEnd(endAttributes, Context.root(), request, response, null);
assertThat(endAttributes.build())
.containsOnly(
entry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 202L),
entry(
AttributeKey.stringArrayKey("http.response.header.custom-response-header"),
asList("654", "321")),
entry(NetworkAttributes.NETWORK_PROTOCOL_VERSION, "1.1"),
entry(NetworkAttributes.NETWORK_PEER_ADDRESS, "4.3.2.1"),
entry(NetworkAttributes.NETWORK_PEER_PORT, 456L));
.containsOnly(
entry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 202L),
entry(
AttributeKey.stringArrayKey("http.response.header.custom-response-header"),
asList("654", "321")),
entry(NetworkAttributes.NETWORK_PROTOCOL_VERSION, "1.1"),
entry(NetworkAttributes.NETWORK_PEER_ADDRESS, "4.3.2.1"),
entry(HttpAttributes.HTTP_REQUEST_METHOD, "POST"),
entry(UrlAttributes.URL_FULL, "http://github.com"),
entry(
AttributeKey.stringArrayKey("http.request.header.custom-request-header"),
asList("123", "456")),
entry(ServerAttributes.SERVER_ADDRESS, "github.com"),
entry(ServerAttributes.SERVER_PORT, 80L),
entry(HttpAttributes.HTTP_REQUEST_RESEND_COUNT, 2L),
entry(NetworkAttributes.NETWORK_PEER_PORT, 456L));
}

@ParameterizedTest
Expand Down Expand Up @@ -354,19 +352,17 @@ void shouldExtractServerAddressAndPortFromHostHeader() {
response.put("statusCode", "200");

AttributesExtractor<Map<String, String>, Map<String, String>> extractor =
HttpClientAttributesExtractor.create(new TestHttpClientAttributesGetter());
HttpClientAttributesExtractor.create(new TestHttpClientAttributesGetter());

AttributesBuilder startAttributes = Attributes.builder();
extractor.onStart(startAttributes, Context.root(), request);
assertThat(startAttributes.build())
.containsOnly(
entry(ServerAttributes.SERVER_ADDRESS, "github.com"),
entry(ServerAttributes.SERVER_PORT, 123L));

AttributesBuilder endAttributes = Attributes.builder();
extractor.onEnd(endAttributes, Context.root(), request, response, null);
assertThat(endAttributes.build())
.containsOnly(entry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200L));
.containsOnly(entry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200L),
entry(ServerAttributes.SERVER_ADDRESS, "github.com"),
entry(ServerAttributes.SERVER_PORT, 123L));
}

@Test
Expand All @@ -381,22 +377,20 @@ void shouldExtractPeerAddressEvenIfItDuplicatesServerAddress() {
response.put("statusCode", "200");

AttributesExtractor<Map<String, String>, Map<String, String>> extractor =
HttpClientAttributesExtractor.create(new TestHttpClientAttributesGetter());
HttpClientAttributesExtractor.create(new TestHttpClientAttributesGetter());

AttributesBuilder startAttributes = Attributes.builder();
extractor.onStart(startAttributes, Context.root(), request);
assertThat(startAttributes.build())
.containsOnly(
entry(ServerAttributes.SERVER_ADDRESS, "1.2.3.4"),
entry(ServerAttributes.SERVER_PORT, 123L));

AttributesBuilder endAttributes = Attributes.builder();
extractor.onEnd(endAttributes, Context.root(), request, response, null);
assertThat(endAttributes.build())
.containsOnly(
entry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200L),
entry(NetworkAttributes.NETWORK_PEER_ADDRESS, "1.2.3.4"),
entry(NetworkAttributes.NETWORK_PEER_PORT, 456L));
.containsOnly(
entry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200L),
entry(NetworkAttributes.NETWORK_PEER_ADDRESS, "1.2.3.4"),
entry(NetworkAttributes.NETWORK_PEER_PORT, 456L),
entry(ServerAttributes.SERVER_ADDRESS, "1.2.3.4"),
entry(ServerAttributes.SERVER_PORT, 123L));
}

@Test
Expand Down
5 changes: 4 additions & 1 deletion ...rc/test/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ void collectsMetrics() {

Attributes responseAttributes =
Attributes.builder()
.put(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200)
.put(HttpAttributes.HTTP_REQUEST_METHOD, "GET")
.put(ServerAttributes.SERVER_PORT, 1234)
.put(ServerAttributes.SERVER_ADDRESS, "localhost")
.put(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200)
.put(ErrorAttributes.ERROR_TYPE, "400")
.put(HttpIncubatingAttributes.HTTP_REQUEST_BODY_SIZE, 100)
.put(HttpIncubatingAttributes.HTTP_RESPONSE_BODY_SIZE, 200)
Expand Down
Loading
Loading