-
Notifications
You must be signed in to change notification settings - Fork 795
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change
http.request.body.size and http.response.body.size attribu…
…tes from recommended to opt-in (#9799)
- Loading branch information
Mateusz Rzeszutek
committed
Nov 2, 2023
1 parent
a1b849e
commit d6c2aff
Showing
62 changed files
with
452 additions
and
195 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
...ntelemetry/instrumentation/api/instrumenter/http/HttpExperimentalAttributesExtractor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.api.instrumenter.http; | ||
|
|
||
| import static io.opentelemetry.instrumentation.api.instrumenter.http.HttpCommonAttributesExtractor.firstHeaderValue; | ||
| import static io.opentelemetry.instrumentation.api.internal.AttributesExtractorUtil.internalSet; | ||
|
|
||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; | ||
| import io.opentelemetry.instrumentation.api.internal.SemconvStability; | ||
| import io.opentelemetry.semconv.SemanticAttributes; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| public final class HttpExperimentalAttributesExtractor<REQUEST, RESPONSE> | ||
| implements AttributesExtractor<REQUEST, RESPONSE> { | ||
|
|
||
| public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create( | ||
| HttpClientAttributesGetter<REQUEST, RESPONSE> getter) { | ||
| return new HttpExperimentalAttributesExtractor<>(getter); | ||
| } | ||
|
|
||
| public static <REQUEST, RESPONSE> AttributesExtractor<REQUEST, RESPONSE> create( | ||
| HttpServerAttributesGetter<REQUEST, RESPONSE> getter) { | ||
| return new HttpExperimentalAttributesExtractor<>(getter); | ||
| } | ||
|
|
||
| private final HttpCommonAttributesGetter<REQUEST, RESPONSE> getter; | ||
|
|
||
| private HttpExperimentalAttributesExtractor( | ||
| HttpCommonAttributesGetter<REQUEST, RESPONSE> getter) { | ||
| this.getter = getter; | ||
| } | ||
|
|
||
| @Override | ||
| 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) { | ||
|
|
||
| if (SemconvStability.emitStableHttpSemconv()) { | ||
| Long requestBodySize = requestBodySize(request); | ||
| internalSet(attributes, SemanticAttributes.HTTP_REQUEST_BODY_SIZE, requestBodySize); | ||
|
|
||
| if (response != null) { | ||
| Long responseBodySize = responseBodySize(request, response); | ||
| internalSet(attributes, SemanticAttributes.HTTP_RESPONSE_BODY_SIZE, responseBodySize); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| private Long requestBodySize(REQUEST request) { | ||
| return parseNumber(firstHeaderValue(getter.getHttpRequestHeader(request, "content-length"))); | ||
| } | ||
|
|
||
| @Nullable | ||
| private Long responseBodySize(REQUEST request, RESPONSE response) { | ||
| return parseNumber( | ||
| firstHeaderValue(getter.getHttpResponseHeader(request, response, "content-length"))); | ||
| } | ||
|
|
||
| @Nullable | ||
| private static Long parseNumber(@Nullable String number) { | ||
| if (number == null) { | ||
| return null; | ||
| } | ||
| try { | ||
| return Long.parseLong(number); | ||
| } catch (NumberFormatException e) { | ||
| // not a number | ||
| return null; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
...emetry/instrumentation/api/instrumenter/http/HttpExperimentalAttributesExtractorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.api.instrumenter.http; | ||
|
|
||
| import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; | ||
| import static java.util.Collections.singletonList; | ||
| import static org.assertj.core.api.Assertions.entry; | ||
| import static org.mockito.Mockito.doReturn; | ||
|
|
||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; | ||
| import io.opentelemetry.semconv.SemanticAttributes; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| class HttpExperimentalAttributesExtractorTest { | ||
|
|
||
| @Mock HttpClientAttributesGetter<String, String> clientGetter; | ||
| @Mock HttpServerAttributesGetter<String, String> serverGetter; | ||
|
|
||
| @Test | ||
| void shouldExtractRequestAndResponseSizes_client() { | ||
| runTest(clientGetter, HttpExperimentalAttributesExtractor.create(clientGetter)); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldExtractRequestAndResponseSizes_server() { | ||
| runTest(serverGetter, HttpExperimentalAttributesExtractor.create(serverGetter)); | ||
| } | ||
|
|
||
| void runTest( | ||
| HttpCommonAttributesGetter<String, String> getter, | ||
| AttributesExtractor<String, String> extractor) { | ||
|
|
||
| doReturn(singletonList("123")).when(getter).getHttpRequestHeader("request", "content-length"); | ||
| doReturn(singletonList("42")) | ||
| .when(getter) | ||
| .getHttpResponseHeader("request", "response", "content-length"); | ||
|
|
||
| AttributesBuilder attributes = Attributes.builder(); | ||
| extractor.onStart(attributes, Context.root(), "request"); | ||
| assertThat(attributes.build()).isEmpty(); | ||
|
|
||
| extractor.onEnd(attributes, Context.root(), "request", "response", null); | ||
| assertThat(attributes.build()) | ||
| .containsOnly( | ||
| entry(SemanticAttributes.HTTP_REQUEST_BODY_SIZE, 123L), | ||
| entry(SemanticAttributes.HTTP_RESPONSE_BODY_SIZE, 42L)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.