opentelemetry-instrumentation-boto3sqs: avoid KeyError when all messages in send_message_batch fail#4746
Open
ferencjuhasz wants to merge 2 commits into
Conversation
xrmx
approved these changes
Jul 1, 2026
c6b4af7 to
9d97aff
Compare
Contributor
|
@ferencjuhasz no need to rebase the changes, we'll take care of that at merge time, thanks! |
Author
|
sorry about that, thanks! |
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
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.
Description
Boto3SQSInstrumentor'ssend_message_batchwrapper unconditionally indexesretval["Successful"]:When every entry in a batch fails, the SQS
SendMessageBatchresponse contains onlyFailedand omits theSuccessfulkey entirely. The wrapper then raisesKeyError: 'Successful'. Because this happens inside the instrumentation wrapper, the exception propagates out ofclient.send_message_batchand breaks the caller — even though the failure is an ordinary per-message batch failure the application is expected to handle from the response.Fix
Iterate over
retval.get("Successful", []). Spans for failed entries are still created and ended by the existing loop, so tracing behavior is otherwise unchanged.Tests
The
send_message_batchwrapper previously had no test coverage. This PR adds:test_send_message_batch— happy path: asserts the producer span per entry, full span attributes, and context propagation injection.test_send_message_batch_all_failed— regression test reproducing theKeyErrorwhen the response has noSuccessfulkey.