Apache HC 5 OTel semantic convention #6591
Merged
+482
−1
Conversation
This file contains hidden or 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
Adds an ObservationConvention implementation for the Apache HC 5 instrumentation that follows the latest (at this time) OpenTelemetry semantic conventions for HTTP clients. Also adds an ObservationDocumentation for it as well.
This will be needed by other HTTP instrumentation.
shakuzen
commented
Aug 7, 2025
| URL { | ||
| @Override | ||
| public String asString() { | ||
| return "url.full"; |
There was a problem hiding this comment.
It's worth mentioning that we have a uri KeyValue on the existing DefaultApacheHttpClientObservationConvention where we try to get a templated URI (although we can't if users don't provide a way to access it). The equivalent in OTel HTTP client semantic conventions is url.template, but it is currently not marked stable. This means that HTTP client metrics using the stable OTel semantic conventions will have no information about the URL being called.
jonatan-ivanov
approved these changes
Aug 7, 2025
...instrument/binder/httpcomponents/hc5/OpenTelemetryApacheHttpClientObservationConvention.java
Outdated
Show resolved
Hide resolved
...trument/binder/httpcomponents/hc5/OpenTelemetryApacheHttpClientObservationDocumentation.java
Outdated
Show resolved
Hide resolved
Specifically, status and port are defined as ints. Uses 0 and -1 for the case when they are unknown/undefined.
jonatan-ivanov
approved these changes
Aug 8, 2025
izeye
added a commit
to izeye/micrometer
that referenced
this pull request
Aug 9, 2025
Signed-off-by: Johnny Lim <izeye@naver.com>
Merged
jonatan-ivanov
pushed a commit
that referenced
this pull request
Aug 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds an ObservationConvention implementation for the Apache HC 5 instrumentation that follows the latest (at this time) OpenTelemetry semantic conventions for HTTP clients. Also adds an ObservationDocumentation for it as well.
Documentation has been updated to demonstrate how the convention can be configured with the instrumentation.