Opensearch transport query sanitization #15634
Open
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
jaydeluca
reviewed
Dec 15, 2025
Comment on lines
+30
to
+34
| if (request.getBody() == null) { | ||
| return request.getMethod() + " " + request.getOperation(); | ||
| } else { | ||
| return request.getBody(); | ||
| } |
Member
There was a problem hiding this comment.
Suggested change
| if (request.getBody() == null) { | |
| return request.getMethod() + " " + request.getOperation(); | |
| } else { | |
| return request.getBody(); | |
| } | |
| if (request.getBody() == null) { | |
| return request.getMethod() + " " + request.getOperation(); | |
| } | |
| return request.getBody(); |
| import org.opensearch.client.json.NdJsonpSerializable; | ||
| import org.opensearch.client.transport.GenericSerializable; | ||
|
|
||
| public class OpenSearchBodyExtractor { |
Member
There was a problem hiding this comment.
Public classes should be declared final where possible (ref)
Suggested change
| public class OpenSearchBodyExtractor { | |
| public final class OpenSearchBodyExtractor { |
| import java.util.Map; | ||
| import java.util.logging.Logger; | ||
|
|
||
| public class OpenSearchBodySanitizer { |
Member
There was a problem hiding this comment.
Suggested change
| public class OpenSearchBodySanitizer { | |
| public final class OpenSearchBodySanitizer { |
Comment on lines
+12
to
+15
| /** | ||
| * Splits multiple queries separated by semicolons. Single Responsibility: Only responsible for | ||
| * query separation logic. | ||
| */ |
Member
There was a problem hiding this comment.
i dont think is right?
Suggested change
| /** | |
| * Splits multiple queries separated by semicolons. Single Responsibility: Only responsible for | |
| * query separation logic. | |
| */ | |
| /** | |
| * Splits and joins queries for newline-delimited JSON (nd-json) format. | |
| * Splits input by newlines and joins output with semicolons for display. | |
| */ |
| testImplementation("software.amazon.awssdk:identity-spi:2.26.0") | ||
| testImplementation("software.amazon.awssdk:apache-client:2.26.0") | ||
| testImplementation("software.amazon.awssdk:netty-nio-client:2.26.0") | ||
| testImplementation("software.amazon.awssdk:netty-nio-client:2.26.0") |
Member
There was a problem hiding this comment.
duplicate
Suggested change
| testImplementation("software.amazon.awssdk:netty-nio-client:2.26.0") |
Comment on lines
+35
to
+45
| public static OpenSearchBodySanitizer create() { | ||
| return new OpenSearchBodySanitizer(DEFAULT_OBJECT_MAPPER); | ||
| } | ||
|
|
||
| public static OpenSearchBodySanitizer create(ObjectMapper objectMapper) { | ||
| return new OpenSearchBodySanitizer(objectMapper); | ||
| } | ||
|
|
||
| public static OpenSearchBodySanitizer getDefault() { | ||
| return DEFAULT_INSTANCE; | ||
| } |
Member
There was a problem hiding this comment.
this all looks to be unused, is it needed?
Suggested change
| public static OpenSearchBodySanitizer create() { | |
| return new OpenSearchBodySanitizer(DEFAULT_OBJECT_MAPPER); | |
| } | |
| public static OpenSearchBodySanitizer create(ObjectMapper objectMapper) { | |
| return new OpenSearchBodySanitizer(objectMapper); | |
| } | |
| public static OpenSearchBodySanitizer getDefault() { | |
| return DEFAULT_INSTANCE; | |
| } |
| if (request instanceof NdJsonpSerializable) { | ||
| writeNdJson(mapper, (NdJsonpSerializable) request, baos); | ||
| } else if (request instanceof GenericSerializable) { | ||
| ContentType.parse(((GenericSerializable) request).serialize(baos)); |
Member
There was a problem hiding this comment.
is the ContentType.parse needed here? could it just be ((GenericSerializable) request).serialize(baos); ?
| server.enqueue(HttpResponse.of(HttpStatus.OK, MediaType.JSON_UTF_8, searchResponseJson)); | ||
| } | ||
|
|
||
| void setupForMsearchResponse() { |
jaydeluca
reviewed
Dec 15, 2025
| | System property | Type | Default | Description | | ||
| |-----------------------------------------------------------------|---------| ------- |------------------------------------------------------| | ||
| | `otel.instrumentation.opensearch.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes. | | ||
| | `otel.instrumentation.opensearch.capture-search-query` | Boolean | `false` | Enable the capture of sanitized search query bodies. | |
Member
There was a problem hiding this comment.
I wonder if it's worth mentioning that this will likely impact performance in some way due to the serialization?
Suggested change
| | `otel.instrumentation.opensearch.capture-search-query` | Boolean | `false` | Enable the capture of sanitized search query bodies. | | |
| | `otel.instrumentation.opensearch.capture-search-query` | Boolean | `false` | Enable the capture of sanitized search query bodies. **Note**: Enabling this feature adds overhead for JSON serialization and parsing on search requests. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Since extracting query body can impact application performance, I made it optional with
otel.instrumentation.elasticsearch.capture-search-query. Not sure if adding this config is okay though.close #15466