opentelemetry-instrumentation-botocore 0.57b0__tar.gz → 0.58b0__tar.gz

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentelemetry-instrumentation-botocore
-Version: 0.57b0
+Version: 0.58b0
 Summary: OpenTelemetry Botocore instrumentation
 Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-botocore
 Project-URL: Repository, https://github.com/open-telemetry/opentelemetry-python-contrib
@@ -19,9 +19,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
 Requires-Dist: opentelemetry-api~=1.30
-Requires-Dist: opentelemetry-instrumentation==0.57b0
+Requires-Dist: opentelemetry-instrumentation==0.58b0
 Requires-Dist: opentelemetry-propagator-aws-xray~=1.0
-Requires-Dist: opentelemetry-semantic-conventions==0.57b0
+Requires-Dist: opentelemetry-semantic-conventions==0.58b0
 Provides-Extra: instruments
 Requires-Dist: botocore~=1.0; extra == 'instruments'
 Description-Content-Type: text/x-rst

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/pyproject.toml

@@ -26,8 +26,8 @@ classifiers = [
 ]
 dependencies = [
   "opentelemetry-api ~= 1.30",
-  "opentelemetry-instrumentation == 0.57b0",
-  "opentelemetry-semantic-conventions == 0.57b0",
+  "opentelemetry-instrumentation == 0.58b0",
+  "opentelemetry-semantic-conventions == 0.58b0",
   "opentelemetry-propagator-aws-xray ~= 1.0",
 ]
 

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/src/opentelemetry/instrumentation/botocore/extensions/__init__.py

@@ -35,6 +35,7 @@ _KNOWN_EXTENSIONS = {
     "bedrock-runtime": _lazy_load(".bedrock", "_BedrockRuntimeExtension"),
     "dynamodb": _lazy_load(".dynamodb", "_DynamoDbExtension"),
     "lambda": _lazy_load(".lmbd", "_LambdaExtension"),
+    "stepfunctions": _lazy_load(".sfns", "_StepFunctionsExtension"),
     "sns": _lazy_load(".sns", "_SnsExtension"),
     "sqs": _lazy_load(".sqs", "_SqsExtension"),
 }

opentelemetry_instrumentation_botocore-0.58b0/src/opentelemetry/instrumentation/botocore/extensions/sfns.py

@@ -0,0 +1,58 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from opentelemetry.instrumentation.botocore.extensions.types import (
+    _AttributeMapT,
+    _AwsSdkExtension,
+    _BotocoreInstrumentorContext,
+    _BotoResultT,
+)
+from opentelemetry.semconv._incubating.attributes.aws_attributes import (
+    AWS_STEP_FUNCTIONS_ACTIVITY_ARN,
+    AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN,
+)
+from opentelemetry.trace.span import Span
+
+
+class _StepFunctionsExtension(_AwsSdkExtension):
+    @staticmethod
+    def _set_arn_attributes(source, target, setter_func):
+        """Helper to set ARN attributes if they exist in source."""
+        activity_arn = source.get("activityArn")
+        if activity_arn:
+            setter_func(target, AWS_STEP_FUNCTIONS_ACTIVITY_ARN, activity_arn)
+
+        state_machine_arn = source.get("stateMachineArn")
+        if state_machine_arn:
+            setter_func(
+                target, AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN, state_machine_arn
+            )
+
+    def extract_attributes(self, attributes: _AttributeMapT):
+        self._set_arn_attributes(
+            self._call_context.params,
+            attributes,
+            lambda target, key, value: target.__setitem__(key, value),
+        )
+
+    def on_success(
+        self,
+        span: Span,
+        result: _BotoResultT,
+        instrumentor_context: _BotocoreInstrumentorContext,
+    ):
+        self._set_arn_attributes(
+            result,
+            span,
+            lambda target, key, value: target.set_attribute(key, value),
+        )

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/src/opentelemetry/instrumentation/botocore/extensions/sns.py

@@ -24,6 +24,10 @@ from opentelemetry.instrumentation.botocore.extensions.types import (
     _AwsSdkCallContext,
     _AwsSdkExtension,
     _BotocoreInstrumentorContext,
+    _BotoResultT,
+)
+from opentelemetry.semconv._incubating.attributes.aws_attributes import (
+    AWS_SNS_TOPIC_ARN,
 )
 from opentelemetry.semconv.trace import (
     MessagingDestinationKindValues,
@@ -161,6 +165,9 @@ class _SnsExtension(_AwsSdkExtension):
 
     def extract_attributes(self, attributes: _AttributeMapT):
         attributes[SpanAttributes.MESSAGING_SYSTEM] = "aws.sns"
+        topic_arn = self._call_context.params.get("TopicArn")
+        if topic_arn:
+            attributes[AWS_SNS_TOPIC_ARN] = topic_arn
 
         if self._op:
             self._op.extract_attributes(self._call_context, attributes)
@@ -170,3 +177,16 @@ class _SnsExtension(_AwsSdkExtension):
     ):
         if self._op:
             self._op.before_service_call(self._call_context, span)
+
+    def on_success(
+        self,
+        span: Span,
+        result: _BotoResultT,
+        instrumentor_context: _BotocoreInstrumentorContext,
+    ):
+        if not span.is_recording():
+            return
+
+        topic_arn = result.get("TopicArn")
+        if topic_arn:
+            span.set_attribute(AWS_SNS_TOPIC_ARN, topic_arn)

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/src/opentelemetry/instrumentation/botocore/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.57b0"
+__version__ = "0.58b0"

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/tests/test_botocore_dynamodb.py

@@ -439,7 +439,7 @@ class TestDynamoDbExtension(TestBase):
             Limit=42,
             Select="ALL_ATTRIBUTES",
             TotalSegments=17,
-            Segment=21,
+            Segment=16,
             ProjectionExpression="PE",
             ConsistentRead=True,
             ReturnConsumedCapacity="TOTAL",
@@ -448,14 +448,14 @@ class TestDynamoDbExtension(TestBase):
         span = self.assert_span("Scan")
         self.assert_table_names(span, self.default_table_name)
         self.assertEqual(
-            21, span.attributes[SpanAttributes.AWS_DYNAMODB_SEGMENT]
+            16, span.attributes[SpanAttributes.AWS_DYNAMODB_SEGMENT]
         )
         self.assertEqual(
             17, span.attributes[SpanAttributes.AWS_DYNAMODB_TOTAL_SEGMENTS]
         )
-        self.assertEqual(1, span.attributes[SpanAttributes.AWS_DYNAMODB_COUNT])
+        self.assertEqual(0, span.attributes[SpanAttributes.AWS_DYNAMODB_COUNT])
         self.assertEqual(
-            1, span.attributes[SpanAttributes.AWS_DYNAMODB_SCANNED_COUNT]
+            0, span.attributes[SpanAttributes.AWS_DYNAMODB_SCANNED_COUNT]
         )
         self.assert_attributes_to_get(span, "id", "idl")
         self.assert_consistent_read(span, True)

opentelemetry_instrumentation_botocore-0.58b0/tests/test_botocore_sfns.py

@@ -0,0 +1,117 @@
+import json
+
+import botocore.session
+from moto import mock_aws
+
+from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
+from opentelemetry.semconv._incubating.attributes.aws_attributes import (
+    AWS_STEP_FUNCTIONS_ACTIVITY_ARN,
+    AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN,
+)
+from opentelemetry.test.test_base import TestBase
+
+
+class TestSfnsExtension(TestBase):
+    def setUp(self):
+        super().setUp()
+        BotocoreInstrumentor().instrument()
+        session = botocore.session.get_session()
+        session.set_credentials(
+            access_key="access-key", secret_key="secret-key"
+        )
+        self.region = "us-west-2"
+        self.client = session.create_client(
+            "stepfunctions", region_name=self.region
+        )
+
+    def tearDown(self):
+        super().tearDown()
+        BotocoreInstrumentor().uninstrument()
+
+    SIMPLE_STATE_MACHINE_DEF = {
+        "Comment": "A simple Hello World example",
+        "StartAt": "HelloState",
+        "States": {
+            "HelloState": {
+                "Type": "Pass",
+                "Result": "Hello, Moto!",
+                "End": True,
+            }
+        },
+    }
+
+    def create_state_machine_and_get_arn(
+        self, name: str = "TestStateMachine"
+    ) -> str:
+        """
+        Create a state machine in mocked Step Functions and return its ARN.
+        """
+        definition_json = json.dumps(self.SIMPLE_STATE_MACHINE_DEF)
+        role_arn = "arn:aws:iam::123456789012:role/DummyRole"
+
+        response = self.client.create_state_machine(
+            name=name,
+            definition=definition_json,
+            roleArn=role_arn,
+        )
+        return response["stateMachineArn"]
+
+    def create_activity_and_get_arn(self, name: str = "TestActivity") -> str:
+        """
+        Create an activity in mocked Step Functions and return its ARN.
+        """
+        response = self.client.create_activity(
+            name=name,
+        )
+        return response["activityArn"]
+
+    @mock_aws
+    def test_sfns_create_state_machine(self):
+        state_machine_arn = self.create_state_machine_and_get_arn()
+        spans = self.memory_exporter.get_finished_spans()
+        assert spans
+        self.assertEqual(len(spans), 1)
+        span = spans[0]
+        self.assertEqual(
+            span.attributes[AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN],
+            state_machine_arn,
+        )
+
+    @mock_aws
+    def test_sfns_describe_state_machine(self):
+        state_machine_arn = self.create_state_machine_and_get_arn()
+        self.client.describe_state_machine(stateMachineArn=state_machine_arn)
+
+        spans = self.memory_exporter.get_finished_spans()
+        assert spans
+        self.assertEqual(len(spans), 2)
+        span = spans[1]
+        self.assertEqual(
+            span.attributes[AWS_STEP_FUNCTIONS_STATE_MACHINE_ARN],
+            state_machine_arn,
+        )
+
+    @mock_aws
+    def test_sfns_create_activity(self):
+        activity_arn = self.create_activity_and_get_arn()
+        spans = self.memory_exporter.get_finished_spans()
+        assert spans
+        self.assertEqual(len(spans), 1)
+        span = spans[0]
+        self.assertEqual(
+            span.attributes[AWS_STEP_FUNCTIONS_ACTIVITY_ARN],
+            activity_arn,
+        )
+
+    @mock_aws
+    def test_sfns_describe_activity(self):
+        activity_arn = self.create_activity_and_get_arn()
+        self.client.describe_activity(activityArn=activity_arn)
+        spans = self.memory_exporter.get_finished_spans()
+        assert spans
+        self.assertEqual(len(spans), 2)
+        span = spans[1]
+        self.assertEqual(
+            span.attributes[AWS_STEP_FUNCTIONS_ACTIVITY_ARN],
+            activity_arn,
+        )

{opentelemetry_instrumentation_botocore-0.57b0 → opentelemetry_instrumentation_botocore-0.58b0}/tests/test_botocore_sns.py

@@ -21,6 +21,9 @@ from botocore.awsrequest import AWSResponse
 from moto import mock_aws
 
 from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
+from opentelemetry.semconv._incubating.attributes.aws_attributes import (
+    AWS_SNS_TOPIC_ARN,
+)
 from opentelemetry.semconv.trace import (
     MessagingDestinationKindValues,
     SpanAttributes,
@@ -151,6 +154,10 @@ class TestSnsExtension(TestBase):
         )
 
         span = self.assert_span(f"{self.topic_name} send")
+        self.assertEqual(
+            topic_arn,
+            span.attributes[AWS_SNS_TOPIC_ARN],
+        )
         self.assert_injected_span(message_attrs, span)
 
     def test_publish_batch_to_topic(self):
@@ -188,6 +195,10 @@ class TestSnsExtension(TestBase):
             MessagingDestinationKindValues.TOPIC.value,
             span.attributes[SpanAttributes.MESSAGING_DESTINATION_KIND],
         )
+        self.assertEqual(
+            topic_arn,
+            span.attributes[AWS_SNS_TOPIC_ARN],
+        )
         self.assertEqual(
             topic_arn,
             span.attributes[SpanAttributes.MESSAGING_DESTINATION],
@@ -199,3 +210,16 @@ class TestSnsExtension(TestBase):
 
         self.assert_injected_span(message1_attrs, span)
         self.assert_injected_span(message2_attrs, span)
+
+    @mock_aws
+    def test_create_topic_span(self):
+        _ = self.client.create_topic(Name=self.topic_name)
+        spans = self.memory_exporter.get_finished_spans()
+        self.assertEqual(1, len(spans))
+        span = spans[0]
+        self.assertEqual(SpanKind.CLIENT, span.kind)
+        self.assertEqual("SNS.CreateTopic", span.name)
+        self.assertEqual(
+            self.topic_arn,
+            span.attributes[AWS_SNS_TOPIC_ARN],
+        )