Merge branch 'master' into dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7

thpierce · web-flow · commit 859963e2700d · 2025-10-06T09:48:29.000-07:00
diff --git a/.github/workflows/IntegrationTesting.yaml b/.github/workflows/IntegrationTesting.yaml
@@ -4,6 +4,10 @@ on:
     branches:
       - master
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   build_SDK:
     name: Build X-Ray Python SDK
@@ -78,10 +82,9 @@ jobs:
         run: cp deploy.zip ./terraform
 
       - name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v4
         with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          role-to-assume: ${{ secrets.AWS_INTEG_TEST_ROLE_ARN }}
           aws-region: us-west-2
 
       - name: Setup Terraform
@@ -126,10 +129,9 @@ jobs:
           java-version: 14
 
       - name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v4
         with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          role-to-assume: ${{ secrets.AWS_INTEG_TEST_ROLE_ARN }}
           aws-region: us-west-2
 
       - name: Checkout test framework
diff --git a/.github/workflows/continuous-monitoring.yml b/.github/workflows/continuous-monitoring.yml
@@ -4,6 +4,10 @@ on:
   schedule:
     - cron:  '*/10 * * * *'
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   smoke-tests:
     name: Run smoke tests
@@ -13,10 +17,9 @@ jobs:
         uses: actions/checkout@v3
       
       - name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v4
         with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          role-to-assume: ${{ secrets.AWS_INTEG_TEST_ROLE_ARN }}
           aws-region: us-east-1
       
       - uses: actions/setup-python@v4
diff --git a/README.md b/README.md
@@ -1,17 +1,34 @@
 ![Build Status](https://github.com/aws/aws-xray-sdk-python/actions/workflows/IntegrationTesting.yaml/badge.svg)
 [![codecov](https://codecov.io/gh/aws/aws-xray-sdk-python/branch/master/graph/badge.svg)](https://codecov.io/gh/aws/aws-xray-sdk-python)
 
-### :mega: OpenTelemetry Python with AWS X-Ray
+# AWS X-Ray SDK for Python
+
+## :mega: Upcoming Maintenance Mode on February 25, 2026
+
+[The AWS X-Ray SDKs will enter maintenance mode on **`February 25, 2026`**][xray-sdk-daemon-timeline]. During maintenance mode, the X-Ray SDKs and Daemon will only receive critical bug fixes and security updates, and will not be updated to support new features.
+
+We recommend that you migrate to [AWS Distro for OpenTelemetry (ADOT) or OpenTelemetry Instrumentation][xray-otel-migration-docs] to generate traces (through manual or zero-code instrumentation) from your application and send them to AWS X-Ray. OpenTelemetry is the industry-wide standard for tracing instrumentation and observability. It has a large open-source community for support and provides more instrumentations and updates. By adopting an OpenTelemetry solution, developers can leverage the latest services and innovations from AWS CloudWatch.
+
+## :mega: End-of-Support on February 25, 2027
+
+[The AWS X-Ray SDKs will reach end-of-support on **`February 25, 2027`**][xray-sdk-daemon-timeline]. After end-of-support, the X-Ray SDKs will no longer receive updates or releases. Previously published releases will continue to be available via public package managers and the source code will remain on GitHub.
+
+[xray-otel-migration-docs]: https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.html
+[xray-sdk-daemon-timeline]: https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon-eos.html
+
+-------------------------------------
+
+### OpenTelemetry Python with AWS X-Ray
 
 AWS X-Ray supports using OpenTelemetry Python and the AWS Distro for OpenTelemetry (ADOT) Collector to instrument your application and send trace data to X-Ray. The OpenTelemetry SDKs are an industry-wide standard for tracing instrumentation. They provide more instrumentations and have a larger community for support, but may not have complete feature parity with the X-Ray SDKs. See [choosing between the ADOT and X-Ray SDKs](https://docs.aws.amazon.com/xray/latest/devguide/xray-instrumenting-your-app.html#xray-instrumenting-choosing) for more help with choosing between the two.
 
 If you want additional features when tracing your Python applications, please [open an issue on the OpenTelemetry Python Instrumentation repository](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/new?labels=feature-request&template=feature_request.md&title=X-Ray%20Compatible%20Feature%20Request).
 
-### :mega: Python Versions End-of-Support Notice
+### Python Versions End-of-Support Notice
 
 AWS X-Ray SDK for Python versions `>2.11.0` has dropped support for Python 2.7, 3.4, 3.5, and 3.6.
 
-# AWS X-Ray SDK for Python
+-------------------------------------
 
 ![Screenshot of the AWS X-Ray console](/images/example_servicemap.png?raw=true)
 
diff --git a/aws_xray_sdk/core/patcher.py b/aws_xray_sdk/core/patcher.py
@@ -23,6 +23,7 @@
     'pymongo',
     'pymysql',
     'psycopg2',
+    'psycopg',
     'pg8000',
     'sqlalchemy_core',
     'httpx',
@@ -38,6 +39,7 @@
     'pymongo',
     'pymysql',
     'psycopg2',
+    'psycopg',
     'pg8000',
     'sqlalchemy_core',
     'httpx',
diff --git a/aws_xray_sdk/ext/psycopg/__init__.py b/aws_xray_sdk/ext/psycopg/__init__.py
@@ -0,0 +1,4 @@
+from .patch import patch
+
+
+__all__ = ['patch']
diff --git a/aws_xray_sdk/ext/psycopg/patch.py b/aws_xray_sdk/ext/psycopg/patch.py
@@ -0,0 +1,37 @@
+import wrapt
+from operator import methodcaller
+
+from aws_xray_sdk.ext.dbapi2 import XRayTracedConn
+
+
+def patch():
+    wrapt.wrap_function_wrapper(
+        'psycopg',
+        'connect',
+        _xray_traced_connect
+    )
+
+    wrapt.wrap_function_wrapper(
+        'psycopg_pool.pool',
+        'ConnectionPool._connect',
+        _xray_traced_connect
+    )
+
+
+def _xray_traced_connect(wrapped, instance, args, kwargs):
+    conn = wrapped(*args, **kwargs)
+    parameterized_dsn = {c[0]: c[-1] for c in map(methodcaller('split', '='), conn.info.dsn.split(' '))}
+    meta = {
+        'database_type': 'PostgreSQL',
+        'url': 'postgresql://{}@{}:{}/{}'.format(
+            parameterized_dsn.get('user', 'unknown'),
+            parameterized_dsn.get('host', 'unknown'),
+            parameterized_dsn.get('port', 'unknown'),
+            parameterized_dsn.get('dbname', 'unknown'),
+        ),
+        'user': parameterized_dsn.get('user', 'unknown'),
+        'database_version': str(conn.info.server_version),
+        'driver_version': 'Psycopg 3'
+    }
+
+    return XRayTracedConn(conn, meta)
diff --git a/docs/conf.py b/docs/conf.py
@@ -177,4 +177,6 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/', None),
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -29,6 +29,7 @@ Currently supported web frameworks and libraries:
 * mysql-connector
 * pg8000
 * psycopg2
+* psycopg (psycopg3)
 * pymongo
 * pymysql
 * pynamodb
diff --git a/sample-apps/flask/requirements.txt b/sample-apps/flask/requirements.txt
@@ -5,7 +5,7 @@ Flask==2.3.3
 idna==3.7
 requests==2.32.0
 urllib3==1.26.19
-Werkzeug==3.0.3
+Werkzeug==3.0.6
 flask-sqlalchemy==2.5.1
 SQLAlchemy==1.4
 aws_xray_sdk==2.6.0
diff --git a/tests/ext/psycopg/__init__.py b/tests/ext/psycopg/__init__.py
diff --git a/tests/ext/psycopg/test_psycopg.py b/tests/ext/psycopg/test_psycopg.py
@@ -0,0 +1,136 @@
+import psycopg
+import psycopg.sql
+import psycopg_pool
+
+import pytest
+import testing.postgresql
+
+from aws_xray_sdk.core import patch
+from aws_xray_sdk.core import xray_recorder
+from aws_xray_sdk.core.context import Context
+
+patch(('psycopg',))
+
+
+@pytest.fixture(autouse=True)
+def construct_ctx():
+    """
+    Clean up context storage on each test run and begin a segment
+    so that later subsegment can be attached. After each test run
+    it cleans up context storage again.
+    """
+    xray_recorder.configure(service='test', sampling=False, context=Context())
+    xray_recorder.clear_trace_entities()
+    xray_recorder.begin_segment('name')
+    yield
+    xray_recorder.clear_trace_entities()
+
+
+def test_execute_dsn_kwargs():
+    q = 'SELECT 1'
+    with testing.postgresql.Postgresql() as postgresql:
+        url = postgresql.url()
+        dsn = postgresql.dsn()
+        conn = psycopg.connect(dbname=dsn['database'],
+                                user=dsn['user'],
+                                password='',
+                                host=dsn['host'],
+                                port=dsn['port'])
+        cur = conn.cursor()
+        cur.execute(q)
+
+    subsegment = xray_recorder.current_segment().subsegments[0]
+    assert subsegment.name == 'execute'
+    sql = subsegment.sql
+    assert sql['database_type'] == 'PostgreSQL'
+    assert sql['user'] == dsn['user']
+    assert sql['url'] == url
+    assert sql['database_version']
+
+
+def test_execute_dsn_string():
+    q = 'SELECT 1'
+    with testing.postgresql.Postgresql() as postgresql:
+        url = postgresql.url()
+        dsn = postgresql.dsn()
+        conn = psycopg.connect('dbname=' + dsn['database'] +
+                                ' password=mypassword' +
+                                ' host=' + dsn['host'] +
+                                ' port=' + str(dsn['port']) +
+                                ' user=' + dsn['user'])
+        cur = conn.cursor()
+        cur.execute(q)
+
+    subsegment = xray_recorder.current_segment().subsegments[0]
+    assert subsegment.name == 'execute'
+    sql = subsegment.sql
+    assert sql['database_type'] == 'PostgreSQL'
+    assert sql['user'] == dsn['user']
+    assert sql['url'] == url
+    assert sql['database_version']
+
+
+def test_execute_in_pool():
+    q = 'SELECT 1'
+    with testing.postgresql.Postgresql() as postgresql:
+        url = postgresql.url()
+        dsn = postgresql.dsn()
+        pool = psycopg_pool.ConnectionPool('dbname=' + dsn['database'] +
+                                            ' password=mypassword' +
+                                            ' host=' + dsn['host'] +
+                                            ' port=' + str(dsn['port']) +
+                                            ' user=' + dsn['user'],
+                                            min_size=1,
+                                            max_size=1)
+        with pool.connection() as conn:
+            cur = conn.cursor()
+            cur.execute(q)
+
+    subsegment = xray_recorder.current_segment().subsegments[0]
+    assert subsegment.name == 'execute'
+    sql = subsegment.sql
+    assert sql['database_type'] == 'PostgreSQL'
+    assert sql['user'] == dsn['user']
+    assert sql['url'] == url
+    assert sql['database_version']
+
+
+def test_execute_bad_query():
+    q = 'SELECT blarg'
+    with testing.postgresql.Postgresql() as postgresql:
+        url = postgresql.url()
+        dsn = postgresql.dsn()
+        conn = psycopg.connect(dbname=dsn['database'],
+                                user=dsn['user'],
+                                password='',
+                                host=dsn['host'],
+                                port=dsn['port'])
+        cur = conn.cursor()
+        try:
+            cur.execute(q)
+        except Exception:
+            pass
+
+    subsegment = xray_recorder.current_segment().subsegments[0]
+    assert subsegment.name == 'execute'
+    sql = subsegment.sql
+    assert sql['database_type'] == 'PostgreSQL'
+    assert sql['user'] == dsn['user']
+    assert sql['url'] == url
+    assert sql['database_version']
+
+    exception = subsegment.cause['exceptions'][0]
+    assert exception.type == 'UndefinedColumn'
+
+def test_query_as_string():
+    with testing.postgresql.Postgresql() as postgresql:
+        url = postgresql.url()
+        dsn = postgresql.dsn()
+        conn = psycopg.connect('dbname=' + dsn['database'] +
+                                ' password=mypassword' +
+                                ' host=' + dsn['host'] +
+                                ' port=' + str(dsn['port']) +
+                                ' user=' + dsn['user'])
+        test_sql = psycopg.sql.Identifier('test')
+        assert test_sql.as_string(conn)
+        assert test_sql.as_string(conn.cursor())
diff --git a/tox.ini b/tox.ini
@@ -30,6 +30,8 @@ envlist =
 
     py{37,38,39,310,311,312}-ext-psycopg2
 
+    py{37,38,39,310,311}-ext-psycopg
+    
     py{37,38,39,310,311,312}-ext-pymysql
 
     py{37,38,39,310,311,312}-ext-pynamodb
@@ -47,9 +49,9 @@ passenv = TOXENV,CI,CODECOV_*
 
 deps =
     ; Testing packages
-    pytest > 3.0.0
+    pytest > 3.0.0, < 8.0.0
     pytest-benchmark
-    coverage == 4.5.4
+    coverage == 7.2.7
     codecov
 
     ; Packages common to all test environments
@@ -65,7 +67,7 @@ deps =
     ext-aiobotocore: pytest-asyncio
 
     ext-aiohttp: aiohttp >= 3.3.0
-    ext-aiohttp: pytest-aiohttp
+    ext-aiohttp: pytest-aiohttp < 1.1.0
 
     ext-httpx: httpx >= 0.20
     ext-httpx: pytest-asyncio >= 0.19
@@ -99,6 +101,10 @@ deps =
     ext-psycopg2: psycopg2
     ext-psycopg2: testing.postgresql
 
+    ext-psycopg: psycopg
+    ext-psycopg: psycopg[pool]
+    ext-psycopg: testing.postgresql
+
     ext-pg8000: pg8000 <= 1.20.0
     ext-pg8000: testing.postgresql
 
@@ -136,6 +142,8 @@ commands =
     ext-pg8000: coverage run --append --source aws_xray_sdk -m pytest tests/ext/pg8000 {posargs}
 
     ext-psycopg2: coverage run --append --source aws_xray_sdk -m pytest tests/ext/psycopg2 {posargs}
+    
+    ext-psycopg: coverage run --append --source aws_xray_sdk -m pytest tests/ext/psycopg {posargs}
 
     ext-pymysql: coverage run --append --source aws_xray_sdk -m pytest tests/ext/pymysql {posargs}
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +from .patch import patch
++
++
 +__all__ = ['patch']