Document HTTP client configurations for all JavaagentHttpClientInstrumenters #14719
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.
This PR addresses the need to document HTTP client configurations for all instrumentations that use
JavaagentHttpClientInstrumenters
. Previously, these configurations were inconsistently documented across different HTTP client instrumentations, making it difficult for users to understand what configuration options were available.Changes Made
Updated existing metadata.yaml files (12 instrumentations)
Created new metadata.yaml files (14 instrumentations)
Fixed -common module structure
-common
modules (play-ws-common, vertx-http-client-common) as these are shared code modules that should not have metadata filesStandardized Configurations
All HTTP client instrumentations that use
JavaagentHttpClientInstrumenters
now consistently document these 6 configurations that are provided byDefaultHttpClientInstrumenterBuilder.configure()
:otel.instrumentation.http.known-methods
- Configures HTTP request methods recognitionotel.instrumentation.http.client.capture-request-headers
- List of HTTP request headers to captureotel.instrumentation.http.client.capture-response-headers
- List of HTTP response headers to captureotel.instrumentation.common.peer-service-mapping
- Mapping from host names/IPs to peer servicesotel.instrumentation.http.client.emit-experimental-telemetry
- Enable experimental HTTP client telemetryotel.instrumentation.http.client.experimental.redact-query-parameters
- Redact sensitive URL parametersImpact
This ensures that all 26 HTTP client instrumentations using
JavaagentHttpClientInstrumenters
have consistent and complete configuration documentation, making it easier for users to understand and configure HTTP client telemetry options across different HTTP client libraries.Fixes #14517.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.