Add Monkey Patch for Gevent

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/patches/_instrumentation_patch.py

@@ -20,6 +20,12 @@ def apply_instrumentation_patches() -> None:
 
     Where possible, automated testing should be run to catch upstream changes resulting in broken patches
     """
+    if _is_installed("gevent"):
+        # pylint: disable=import-outside-toplevel
+        # Delay import to only occur if monkey patch is needed (e.g. gevent is used to run application).
+        from gevent import monkey
+
+        monkey.patch_ssl()
 
     if _is_installed("botocore ~= 1.0"):
         # pylint: disable=import-outside-toplevel

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_instrumentation_patch.py

@@ -1,5 +1,6 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
+import sys
 from typing import Dict
 from unittest import TestCase
 from unittest.mock import MagicMock, patch
@@ -57,12 +58,14 @@ def _run_patch_behaviour_tests(self):
 
         # Validate unpatched upstream behaviour - important to detect upstream changes that may break instrumentation
         self._test_unpatched_botocore_instrumentation()
+        self._test_unpatched_gevent_ssl_instrumentation()
 
         # Apply patches
         apply_instrumentation_patches()
 
         # Validate patched upstream behaviour - important to detect downstream changes that may break instrumentation
         self._test_patched_botocore_instrumentation()
+        self._test_patched_gevent_ssl_instrumentation()
 
         # Test teardown
         self._reset_mocks()
@@ -93,6 +96,10 @@ def _test_unpatched_botocore_instrumentation(self):
         self.assertFalse("aws.sqs.queue_url" in attributes)
         self.assertFalse("aws.sqs.queue_name" in attributes)
 
+    def _test_unpatched_gevent_ssl_instrumentation(self):
+        # Ssl
+        self.assertFalse("gevent.ssl" in sys.modules, "Upstream has added the gevent ssl patch")
+
     def _test_patched_botocore_instrumentation(self):
         # Kinesis
         self.assertTrue("kinesis" in _KNOWN_EXTENSIONS)
@@ -115,6 +122,10 @@ def _test_patched_botocore_instrumentation(self):
         self.assertTrue("aws.sqs.queue_name" in sqs_attributes)
         self.assertEqual(sqs_attributes["aws.sqs.queue_name"], _QUEUE_NAME)
 
+    def _test_patched_gevent_ssl_instrumentation(self):
+        # Ssl
+        self.assertTrue("gevent.ssl" in sys.modules)
+
     def _test_botocore_installed_flag(self):
         with patch(
             "amazon.opentelemetry.distro.patches._botocore_patches._apply_botocore_instrumentation_patches"

dev-requirements.txt

@@ -14,4 +14,4 @@ codespell==2.1.0
 requests==2.32.0
 ruamel.yaml==0.17.21
 flaky==3.7.0
-botocore==1.34.67
+botocore==1.34.67

tox.ini

@@ -30,6 +30,7 @@ commands_pre =
 ; Install common packages for all the tests. These are not needed in all the
 ; cases but it saves a lot of boilerplate in this file.
   test: pip install botocore
+  test: pip install gevent
   test: pip install "opentelemetry-api[test] @ {env:CORE_REPO}#egg=opentelemetry-api&subdirectory=opentelemetry-api"
   test: pip install "opentelemetry-sdk[test] @ {env:CORE_REPO}#egg=opentelemetry-sdk&subdirectory=opentelemetry-sdk"
   test: pip install "opentelemetry-instrumentation[test] @ {env:CONTRIB_REPO}#egg=opentelemetry-instrumentation&subdirectory=opentelemetry-instrumentation"