opentelemetry-instrumentation-boto3sqs: avoid KeyError when all messages in send_message_batch fail (#4746)

* opentelemetry-instrumentation-boto3sqs: avoid KeyError when all messages in send_message_batch fail

* opentelemetry-instrumentation-boto3sqs: add changelog fragment

---------

Co-authored-by: Emídio <9735060+emdneto@users.noreply.github.com>

Author: ferencjuhasz

.changelog/4746.fixed

@@ -0,0 +1 @@
+`opentelemetry-instrumentation-boto3sqs`: handle missing `Successful` key in `send_message_batch` response when all messages fail

instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py

@@ -267,7 +267,7 @@ def send_batch_wrapper(wrapped, instance, args, kwargs):
                         entry["MessageAttributes"], setter=boto3sqs_setter
                     )
             retval = wrapped(*args, **kwargs)
-            for successful_messages in retval["Successful"]:
+            for successful_messages in retval.get("Successful", []):
                 message_identifier = successful_messages["Id"]
                 message_span = ids_to_spans.get(message_identifier)
                 if message_span:

instrumentation/opentelemetry-instrumentation-boto3sqs/tests/test_boto3sqs_instrumentation.py

@@ -282,6 +282,79 @@ def test_send_message(self):
         )
         self._assert_injected_span(message_attrs, span)
 
+    def test_send_message_batch(self):
+        expected_message_ids = {"1": "msg-1", "2": "msg-2"}
+        mock_response = {
+            "Successful": [
+                {"Id": "1", "MessageId": "msg-1", "MD5OfMessageBody": "11"},
+                {"Id": "2", "MessageId": "msg-2", "MD5OfMessageBody": "22"},
+            ],
+            "Failed": [],
+        }
+        entries = [
+            {"Id": "1", "MessageBody": "hello 1"},
+            {"Id": "2", "MessageBody": "hello 2"},
+        ]
+
+        with self._mocked_endpoint(mock_response):
+            self._client.send_message_batch(
+                QueueUrl=self._queue_url, Entries=entries
+            )
+
+        spans = self.get_finished_spans()
+        self.assertEqual(2, len(spans))
+        spans_by_entry_id = {
+            span.attributes[SpanAttributes.MESSAGING_CONVERSATION_ID]: span
+            for span in spans
+        }
+        for entry in entries:
+            entry_id = entry["Id"]
+            span = spans_by_entry_id[entry_id]
+            self.assertEqual(f"{self._queue_name} send", span.name)
+            self.assertEqual(SpanKind.PRODUCER, span.kind)
+            self.assertEqual(
+                {
+                    SpanAttributes.MESSAGING_CONVERSATION_ID: entry_id,
+                    SpanAttributes.MESSAGING_MESSAGE_ID: expected_message_ids[
+                        entry_id
+                    ],
+                    **self._default_span_attrs(),
+                },
+                span.attributes,
+            )
+            self._assert_injected_span(entry["MessageAttributes"], span)
+
+    def test_send_message_batch_all_failed(self):
+        mock_response = {
+            "Failed": [
+                {
+                    "Id": "1",
+                    "SenderFault": True,
+                    "Code": "InvalidParameterValue",
+                    "Message": "boom",
+                }
+            ]
+        }
+        entries = [{"Id": "1", "MessageBody": "hello 1"}]
+
+        with self._mocked_endpoint(mock_response):
+            self._client.send_message_batch(
+                QueueUrl=self._queue_url, Entries=entries
+            )
+
+        span = self._get_only_span()
+        self.assertEqual(f"{self._queue_name} send", span.name)
+        self.assertEqual(SpanKind.PRODUCER, span.kind)
+        self.assertEqual(
+            {
+                SpanAttributes.MESSAGING_CONVERSATION_ID: "1",
+                **self._default_span_attrs(),
+            },
+            span.attributes,
+        )
+        self.assertNotIn(SpanAttributes.MESSAGING_MESSAGE_ID, span.attributes)
+        self._assert_injected_span(entries[0]["MessageAttributes"], span)
+
     def test_receive_message(self):
         msg_def = {
             "1": {"receipt": "01", "trace_id": 10, "span_id": 1},