Separate HTTP client/server AttributesExtractors #4195
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.api.instrumenter.http; | ||
|
|
||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import io.opentelemetry.semconv.trace.attributes.SemanticAttributes; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
|
|
||
| /** | ||
| * Extractor of <a | ||
| * href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-client">HTTP | ||
| * client attributes</a>. Instrumentation of HTTP client frameworks should extend this class, | ||
| * defining {@link REQUEST} and {@link RESPONSE} with the actual request / response types of the | ||
| * instrumented library. If an attribute is not available in this library, it is appropriate to | ||
| * return {@code null} from the protected attribute methods, but implement as many as possible for | ||
| * best compliance with the OpenTelemetry specification. | ||
| */ | ||
| public abstract class HttpClientAttributesExtractor<REQUEST, RESPONSE> | ||
| extends HttpCommonAttributesExtractor<REQUEST, RESPONSE> { | ||
|
|
||
| @Override | ||
| protected final void onStart(AttributesBuilder attributes, REQUEST request) { | ||
| super.onStart(attributes, request); | ||
| set(attributes, SemanticAttributes.HTTP_URL, url(request)); | ||
|
|
||
| // TODO: these are specific to servers, should we remove those? | ||
| set(attributes, SemanticAttributes.HTTP_TARGET, target(request)); | ||
| set(attributes, SemanticAttributes.HTTP_HOST, host(request)); | ||
| set(attributes, SemanticAttributes.HTTP_SCHEME, scheme(request)); | ||
|
Comment on lines
+28
to
+32
There was a problem hiding this comment. +1 for removing these. We can always add them later if there's really a compelling reason. cc: @lmolkova |
||
| } | ||
|
|
||
| @Override | ||
| protected final void onEnd( | ||
| AttributesBuilder attributes, | ||
| REQUEST request, | ||
| @Nullable RESPONSE response, | ||
| @Nullable Throwable error) { | ||
| super.onEnd(attributes, request, response, error); | ||
| } | ||
|
|
||
| // Attributes that always exist in a request | ||
|
|
||
| @Nullable | ||
| protected abstract String url(REQUEST request); | ||
|
|
||
| // TODO: this is specific to servers, should we remove this? | ||
| @Nullable | ||
| protected abstract String target(REQUEST request); | ||
|
|
||
| // TODO: this is specific to servers, should we remove this? | ||
| @Nullable | ||
| protected abstract String host(REQUEST request); | ||
|
|
||
| // TODO: this is specific to servers, should we remove this? | ||
| @Nullable | ||
| protected abstract String scheme(REQUEST request); | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.instrumentation.api.instrumenter.http; | ||
|
|
||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import io.opentelemetry.context.Context; | ||
| import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; | ||
| import io.opentelemetry.semconv.trace.attributes.SemanticAttributes; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
|
|
||
| /** | ||
| * Extractor of <a | ||
| * href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-server">HTTP | ||
| * server attributes</a>. Instrumentation of HTTP server frameworks should extend this class, | ||
| * defining {@link REQUEST} and {@link RESPONSE} with the actual request / response types of the | ||
| * instrumented library. If an attribute is not available in this library, it is appropriate to | ||
| * return {@code null} from the protected attribute methods, but implement as many as possible for | ||
| * best compliance with the OpenTelemetry specification. | ||
| */ | ||
| public abstract class HttpServerAttributesExtractor<REQUEST, RESPONSE> | ||
| extends HttpCommonAttributesExtractor<REQUEST, RESPONSE> { | ||
|
|
||
| @Override | ||
| protected final void onStart(AttributesBuilder attributes, REQUEST request) { | ||
| super.onStart(attributes, request); | ||
|
|
||
| set(attributes, SemanticAttributes.HTTP_SCHEME, scheme(request)); | ||
| set(attributes, SemanticAttributes.HTTP_HOST, host(request)); | ||
| set(attributes, SemanticAttributes.HTTP_TARGET, target(request)); | ||
| set(attributes, SemanticAttributes.HTTP_ROUTE, route(request)); | ||
|
|
||
| // TODO: this is specific to clients, should we remove this? | ||
| set(attributes, SemanticAttributes.HTTP_URL, url(request)); | ||
|
Comment on lines
+34
to
+36
There was a problem hiding this comment. same, +1 for removing this and we can always add it later if there's really a compelling reason. There was a problem hiding this comment. I am not sure that we can remove this. I arbitrary took a couple of server instrumentation's extractor, and they all returned |
||
| } | ||
|
|
||
| @Override | ||
| protected final void onEnd( | ||
| AttributesBuilder attributes, | ||
| REQUEST request, | ||
| @Nullable RESPONSE response, | ||
| @Nullable Throwable error) { | ||
|
|
||
| super.onEnd(attributes, request, response, error); | ||
| set(attributes, SemanticAttributes.HTTP_SERVER_NAME, serverName(request, response)); | ||
| } | ||
|
|
||
| // Attributes that always exist in a request | ||
|
|
||
| // TODO: this is specific to clients, should we remove this? | ||
| @Nullable | ||
| protected abstract String url(REQUEST request); | ||
|
|
||
| @Nullable | ||
| protected abstract String target(REQUEST request); | ||
|
|
||
| @Nullable | ||
| protected abstract String host(REQUEST request); | ||
|
|
||
| @Nullable | ||
| protected abstract String route(REQUEST request); | ||
|
|
||
| @Nullable | ||
| protected abstract String scheme(REQUEST request); | ||
|
|
||
| // Attributes which are not always available when the request is ready. | ||
|
|
||
| /** | ||
| * Extracts the {@code http.server_name} span attribute. | ||
| * | ||
| * <p>This is called from {@link Instrumenter#end(Context, Object, Object, Throwable)}, whether | ||
| * {@code response} is {@code null} or not. | ||
| */ | ||
| @Nullable | ||
| protected abstract String serverName(REQUEST request, @Nullable RESPONSE response); | ||
| } | ||
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.