Contract Test

Author: Johnnyl202

aws-opentelemetry-distro/pyproject.toml

@@ -8,7 +8,7 @@ dynamic = ["version"]
 description = "AWS OpenTelemetry Python Distro"
 readme = "README.rst"
 license = "Apache-2.0"
-requires-python = ">=3.9"
+requires-python = ">=3.8"
 authors = [
   { name = "Amazon Web Services" },
 ]
@@ -18,70 +18,68 @@ classifiers = [
   "License :: OSI Approved :: Apache Software License",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
 ]
 
 dependencies = [
-  "opentelemetry-api == 1.33.1",
-  "opentelemetry-sdk == 1.33.1",
-  "opentelemetry-exporter-otlp-proto-grpc == 1.33.1",
-  "opentelemetry-exporter-otlp-proto-http == 1.33.1",
-  "opentelemetry-propagator-b3 == 1.33.1",
-  "opentelemetry-propagator-jaeger == 1.33.1",
-  "opentelemetry-exporter-otlp-proto-common == 1.33.1",
+  "opentelemetry-api == 1.27.0",
+  "opentelemetry-sdk == 1.27.0",
+  "opentelemetry-exporter-otlp-proto-grpc == 1.27.0",
+  "opentelemetry-exporter-otlp-proto-http == 1.27.0",
+  "opentelemetry-propagator-b3 == 1.27.0",
+  "opentelemetry-propagator-jaeger == 1.27.0",
+  "opentelemetry-exporter-otlp-proto-common == 1.27.0",
   "opentelemetry-sdk-extension-aws == 2.0.2",
   "opentelemetry-propagator-aws-xray == 1.0.1",
-  "opentelemetry-distro == 0.54b1",
-  "opentelemetry-processor-baggage == 0.54b1",
-  "opentelemetry-propagator-ot-trace == 0.54b1",
-  "opentelemetry-instrumentation == 0.54b1",
-  "opentelemetry-instrumentation-aws-lambda == 0.54b1",
-  "opentelemetry-instrumentation-aio-pika == 0.54b1",
-  "opentelemetry-instrumentation-aiohttp-client == 0.54b1",
-  "opentelemetry-instrumentation-aiopg == 0.54b1",
-  "opentelemetry-instrumentation-asgi == 0.54b1",
-  "opentelemetry-instrumentation-asyncpg == 0.54b1",
-  "opentelemetry-instrumentation-boto == 0.54b1",
-  "opentelemetry-instrumentation-boto3sqs == 0.54b1",
-  "opentelemetry-instrumentation-botocore == 0.54b1",
-  "opentelemetry-instrumentation-celery == 0.54b1",
-  "opentelemetry-instrumentation-confluent-kafka == 0.54b1",
-  "opentelemetry-instrumentation-dbapi == 0.54b1",
-  "opentelemetry-instrumentation-django == 0.54b1",
-  "opentelemetry-instrumentation-elasticsearch == 0.54b1",
-  "opentelemetry-instrumentation-falcon == 0.54b1",
-  "opentelemetry-instrumentation-fastapi == 0.54b1",
-  "opentelemetry-instrumentation-flask == 0.54b1",
-  "opentelemetry-instrumentation-grpc == 0.54b1",
-  "opentelemetry-instrumentation-httpx == 0.54b1",
-  "opentelemetry-instrumentation-jinja2 == 0.54b1",
-  "opentelemetry-instrumentation-kafka-python == 0.54b1",
-  "opentelemetry-instrumentation-logging == 0.54b1",
-  "opentelemetry-instrumentation-mysql == 0.54b1",
-  "opentelemetry-instrumentation-mysqlclient == 0.54b1",
-  "opentelemetry-instrumentation-pika == 0.54b1",
-  "opentelemetry-instrumentation-psycopg2 == 0.54b1",
-  "opentelemetry-instrumentation-pymemcache == 0.54b1",
-  "opentelemetry-instrumentation-pymongo == 0.54b1",
-  "opentelemetry-instrumentation-pymysql == 0.54b1",
-  "opentelemetry-instrumentation-pyramid == 0.54b1",
-  "opentelemetry-instrumentation-redis == 0.54b1",
-  "opentelemetry-instrumentation-remoulade == 0.54b1",
-  "opentelemetry-instrumentation-requests == 0.54b1",
-  "opentelemetry-instrumentation-sqlalchemy == 0.54b1",
-  "opentelemetry-instrumentation-sqlite3 == 0.54b1",
-  "opentelemetry-instrumentation-starlette == 0.54b1",
-  "opentelemetry-instrumentation-system-metrics == 0.54b1",
-  "opentelemetry-instrumentation-tornado == 0.54b1",
-  "opentelemetry-instrumentation-tortoiseorm == 0.54b1",
-  "opentelemetry-instrumentation-urllib == 0.54b1",
-  "opentelemetry-instrumentation-urllib3 == 0.54b1",
-  "opentelemetry-instrumentation-wsgi == 0.54b1",
-  "opentelemetry-instrumentation-cassandra == 0.54b1",
+  "opentelemetry-distro == 0.48b0",
+  "opentelemetry-propagator-ot-trace == 0.48b0",
+  "opentelemetry-instrumentation == 0.48b0",
+  "opentelemetry-instrumentation-aws-lambda == 0.48b0",
+  "opentelemetry-instrumentation-aio-pika == 0.48b0",
+  "opentelemetry-instrumentation-aiohttp-client == 0.48b0",
+  "opentelemetry-instrumentation-aiopg == 0.48b0",
+  "opentelemetry-instrumentation-asgi == 0.48b0",
+  "opentelemetry-instrumentation-asyncpg == 0.48b0",
+  "opentelemetry-instrumentation-boto == 0.48b0",
+  "opentelemetry-instrumentation-boto3sqs == 0.48b0",
+  "opentelemetry-instrumentation-botocore == 0.48b0",
+  "opentelemetry-instrumentation-celery == 0.48b0",
+  "opentelemetry-instrumentation-confluent-kafka == 0.48b0",
+  "opentelemetry-instrumentation-dbapi == 0.48b0",
+  "opentelemetry-instrumentation-django == 0.48b0",
+  "opentelemetry-instrumentation-elasticsearch == 0.48b0",
+  "opentelemetry-instrumentation-falcon == 0.48b0",
+  "opentelemetry-instrumentation-fastapi == 0.48b0",
+  "opentelemetry-instrumentation-flask == 0.48b0",
+  "opentelemetry-instrumentation-grpc == 0.48b0",
+  "opentelemetry-instrumentation-httpx == 0.48b0",
+  "opentelemetry-instrumentation-jinja2 == 0.48b0",
+  "opentelemetry-instrumentation-kafka-python == 0.48b0",
+  "opentelemetry-instrumentation-logging == 0.48b0",
+  "opentelemetry-instrumentation-mysql == 0.48b0",
+  "opentelemetry-instrumentation-mysqlclient == 0.48b0",
+  "opentelemetry-instrumentation-pika == 0.48b0",
+  "opentelemetry-instrumentation-psycopg2 == 0.48b0",
+  "opentelemetry-instrumentation-pymemcache == 0.48b0",
+  "opentelemetry-instrumentation-pymongo == 0.48b0",
+  "opentelemetry-instrumentation-pymysql == 0.48b0",
+  "opentelemetry-instrumentation-pyramid == 0.48b0",
+  "opentelemetry-instrumentation-redis == 0.48b0",
+  "opentelemetry-instrumentation-remoulade == 0.48b0",
+  "opentelemetry-instrumentation-requests == 0.48b0",
+  "opentelemetry-instrumentation-sqlalchemy == 0.48b0",
+  "opentelemetry-instrumentation-sqlite3 == 0.48b0",
+  "opentelemetry-instrumentation-starlette == 0.48b0",
+  "opentelemetry-instrumentation-system-metrics == 0.48b0",
+  "opentelemetry-instrumentation-tornado == 0.48b0",
+  "opentelemetry-instrumentation-tortoiseorm == 0.48b0",
+  "opentelemetry-instrumentation-urllib == 0.48b0",
+  "opentelemetry-instrumentation-urllib3 == 0.48b0",
+  "opentelemetry-instrumentation-wsgi == 0.48b0",
+  "opentelemetry-instrumentation-cassandra == 0.48b0",
 ]
 
 [project.optional-dependencies]
@@ -111,4 +109,4 @@ include = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/amazon"]
+packages = ["src/amazon"]

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/loggertwo.log

@@ -0,0 +1,21 @@
+# Meant to be run from aws-otel-python-instrumentation/contract-tests.
+# Assumes existence of dist/aws_opentelemetry_distro-<pkg_version>-py3-none-any.whl.
+# Assumes filename of aws_opentelemetry_distro-<pkg_version>-py3-none-any.whl is passed in as "DISTRO" arg.
+FROM python:3.10
+WORKDIR /mcp
+COPY ./dist/$DISTRO /mcp
+COPY ./contract-tests/images/applications/mcp /mcp
+COPY ./aws-opentelemetry-distro/src/amazon/opentelemetry/distro/mcpinstrumentor /mcp/mcpinstrumentor
+
+ENV PIP_ROOT_USER_ACTION=ignore
+ARG DISTRO
+
+# Install your MCP instrumentor first (use -e for editable install)
+RUN pip install --upgrade pip && pip install -e ./mcpinstrumentor/
+
+# Then install other requirements and the main distro
+RUN pip install -r requirements.txt && pip install ${DISTRO} --force-reinstall
+RUN opentelemetry-bootstrap -a install
+
+# Without `-u`, logs will be buffered and `wait_for_logs` will never return.
+CMD ["opentelemetry-instrument", "python3", "-u", "./simple_client.py"]

contract-tests/images/applications/mcp/Dockerfile

@@ -0,0 +1,44 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+import asyncio
+import os
+from http.server import BaseHTTPRequestHandler, HTTPServer
+
+from mcp import ClientSession, StdioServerParameters
+from mcp.client.stdio import stdio_client
+
+
+class MCPHandler(BaseHTTPRequestHandler):
+    def do_GET(self):
+        if self.path == "/mcp/echo":
+            asyncio.run(self._call_mcp_tool("echo", {"text": "Hello from HTTP request!"}))
+            self.send_response(200)
+            self.end_headers()
+        else:
+            self.send_response(404)
+            self.end_headers()
+
+    async def _call_mcp_tool(self, tool_name, arguments):
+        server_env = {
+            "OTEL_PYTHON_DISTRO": "aws_distro",
+            "OTEL_PYTHON_CONFIGURATOR": "aws_configurator",
+            "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": os.environ.get("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT", ""),
+            "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",
+            "OTEL_TRACES_SAMPLER": "always_on",
+            "OTEL_METRICS_EXPORTER": "none",
+            "OTEL_LOGS_EXPORTER": "none",
+        }
+        server_params = StdioServerParameters(
+            command="opentelemetry-instrument", args=["python3", "simple_mcp_server.py"], env=server_env
+        )
+        async with stdio_client(server_params) as (read, write):
+            async with ClientSession(read, write) as session:
+                await session.initialize()
+                result = await session.call_tool(tool_name, arguments)
+                return result
+
+
+if __name__ == "__main__":
+    print("Ready")
+    server = HTTPServer(("0.0.0.0", 8080), MCPHandler)
+    server.serve_forever()

contract-tests/images/applications/mcp/client.py

@@ -0,0 +1,16 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from fastmcp import FastMCP
+
+# Create FastMCP server instance
+mcp = FastMCP("Simple MCP Server")
+
+
+@mcp.tool(name="echo", description="Echo the provided text")
+def echo(text: str) -> str:
+    """Echo the provided text"""
+    return f"Echo: {text}"
+
+
+if __name__ == "__main__":
+    mcp.run()

contract-tests/images/applications/mcp/mcp_server.py

@@ -0,0 +1,10 @@
+[project]
+name = "mcp-client-app"
+description = "Simple MCP client that calls echo tool for testing MCP instrumentation"
+version = "1.0.0"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "mcp>=1.1.0",
+    "fastmcp>=0.1.0"
+]

contract-tests/images/applications/mcp/pyproject.toml

@@ -0,0 +1,2 @@
+mcp>=1.1.0
+fastmcp>=0.1.0

contract-tests/images/applications/mcp/requirements.txt

@@ -0,0 +1,112 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from typing_extensions import override
+
+from amazon.base.contract_test_base import ContractTestBase
+from opentelemetry.proto.trace.v1.trace_pb2 import Span
+
+
+class MCPTest(ContractTestBase):
+
+    @override
+    @staticmethod
+    def get_application_image_name() -> str:
+        return "aws-application-signals-tests-mcp-app"
+
+    def test_mcp_echo_tool(self):
+        """Test MCP echo tool call creates proper spans"""
+        self.do_test_requests("mcp/echo", "GET", 200, 0, 0, tool_name="echo")
+
+    @override
+    def _assert_aws_span_attributes(self, resource_scope_spans, path: str, **kwargs) -> None:
+        pass
+
+    @override
+    def _assert_semantic_conventions_span_attributes(
+        self, resource_scope_spans, method: str, path: str, status_code: int, **kwargs
+    ) -> None:
+
+        tool_name = kwargs.get("tool_name", "echo")
+        initialize_client_span = None
+        list_tools_client_span = None
+        list_tools_server_span = None
+        call_tool_client_span = None
+        call_tool_server_span = None
+
+        for resource_scope_span in resource_scope_spans:
+            span = resource_scope_span.span
+
+            if span.name == "client.send_request" and span.kind == Span.SPAN_KIND_CLIENT:
+                for attr in span.attributes:
+                    if attr.key == "mcp.initialize" and attr.value.bool_value:
+                        initialize_client_span = span
+                        break
+                    elif attr.key == "mcp.list_tools" and attr.value.bool_value:
+                        list_tools_client_span = span
+                        break
+                    elif attr.key == "mcp.call_tool" and attr.value.bool_value:
+                        call_tool_client_span = span
+                        break
+
+            elif span.name == "tools/list" and span.kind == Span.SPAN_KIND_SERVER:
+                list_tools_server_span = span
+            elif span.name == f"tools/{tool_name}" and span.kind == Span.SPAN_KIND_SERVER:
+                call_tool_server_span = span
+
+        # Validate initialize client span (no server span expected)
+        self.assertIsNotNone(initialize_client_span, "Initialize client span not found")
+        self.assertEqual(initialize_client_span.kind, Span.SPAN_KIND_CLIENT)
+
+        init_attributes = {attr.key: attr.value for attr in initialize_client_span.attributes}
+        self.assertIn("mcp.initialize", init_attributes)
+        self.assertTrue(init_attributes["mcp.initialize"].bool_value)
+
+        # Validate list tools client span
+        self.assertIsNotNone(list_tools_client_span, "List tools client span not found")
+        self.assertEqual(list_tools_client_span.kind, Span.SPAN_KIND_CLIENT)
+
+        list_client_attributes = {attr.key: attr.value for attr in list_tools_client_span.attributes}
+        self.assertIn("mcp.list_tools", list_client_attributes)
+        self.assertTrue(list_client_attributes["mcp.list_tools"].bool_value)
+
+        # Validate list tools server span
+        self.assertIsNotNone(list_tools_server_span, "List tools server span not found")
+        self.assertEqual(list_tools_server_span.kind, Span.SPAN_KIND_SERVER)
+
+        list_server_attributes = {attr.key: attr.value for attr in list_tools_server_span.attributes}
+        self.assertIn("mcp.list_tools", list_server_attributes)
+        self.assertTrue(list_server_attributes["mcp.list_tools"].bool_value)
+
+        # Validate call tool client span
+        self.assertIsNotNone(call_tool_client_span, f"Call tool client span for {tool_name} not found")
+        self.assertEqual(call_tool_client_span.kind, Span.SPAN_KIND_CLIENT)
+
+        call_client_attributes = {attr.key: attr.value for attr in call_tool_client_span.attributes}
+        self.assertIn("mcp.call_tool", call_client_attributes)
+        self.assertTrue(call_client_attributes["mcp.call_tool"].bool_value)
+        self.assertIn("aws.remote.operation", call_client_attributes)
+        self.assertEqual(call_client_attributes["aws.remote.operation"].string_value, tool_name)
+
+        # Validate call tool server span
+        self.assertIsNotNone(call_tool_server_span, f"Call tool server span for {tool_name} not found")
+        self.assertEqual(call_tool_server_span.kind, Span.SPAN_KIND_SERVER)
+
+        call_server_attributes = {attr.key: attr.value for attr in call_tool_server_span.attributes}
+        self.assertIn("mcp.call_tool", call_server_attributes)
+        self.assertTrue(call_server_attributes["mcp.call_tool"].bool_value)
+
+        # Validate distributed tracing for paired spans
+        self.assertEqual(
+            list_tools_server_span.trace_id,
+            list_tools_client_span.trace_id,
+            "List tools client and server spans should have the same trace ID",
+        )
+        self.assertEqual(
+            call_tool_server_span.trace_id,
+            call_tool_client_span.trace_id,
+            "Call tool client and server spans should have the same trace ID",
+        )
+
+    @override
+    def _assert_metric_attributes(self, resource_scope_metrics, metric_name: str, expected_sum: int, **kwargs) -> None:
+        pass