Merge branch 'main' into kludex/types-urllib

.github/workflows/component-owners.yml

@@ -10,6 +10,10 @@ jobs:
   run_self:
     runs-on: ubuntu-latest
     name: Auto Assign Owners
+    permissions: 
+      contents: read          # to read changed files 
+      issues: write           # to read/write issue assignees 
+      pull-requests: write    # to read/write PR reviewers 
     # Don't fail tests if this workflow fails. Some pending issues:
     # - https://github.com/dyladan/component-owners/issues/8
     continue-on-error: true

.github/workflows/misc_0.yml

@@ -152,3 +152,21 @@ jobs:
 
       - name: Run tests
         run: tox -e ruff
+
+  typecheck:
+    name: typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests
+        run: tox -e typecheck

CHANGELOG.md

@@ -19,21 +19,55 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#3111](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3111))
 - `opentelemetry-instrumentation-urllib` Add `py.typed` file to enable PEP 561
   ([#3131](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3131))
+- `opentelemetry-opentelemetry-pymongo` Add `py.typed` file to enable PEP 561
+  ([#3136](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3136))
+- `opentelemetry-opentelemetry-requests` Add `py.typed` file to enable PEP 561
+  ([#3135](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3135))
 - `opentelemetry-instrumentation-system-metrics` Add `py.typed` file to enable PEP 561
   ([#3132](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3132))
 - `opentelemetry-opentelemetry-sqlite3` Add `py.typed` file to enable PEP 561
   ([#3133](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3133))
 - `opentelemetry-instrumentation-falcon` add support version to v4
   ([#3086](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3086))
+- `opentelemetry-instrumentation-falcon` Implement new HTTP semantic convention opt-in for Falcon
+  ([#2790](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2790))
 - `opentelemetry-instrumentation-wsgi` always record span status code to have it available in metrics
   ([#3148](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3148))
 - add support to Python 3.13
   ([#3134](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3134))
+- `opentelemetry-opentelemetry-wsgi` Add `py.typed` file to enable PEP 561
+  ([#3129](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3129))
+- `opentelemetry-util-http` Add `py.typed` file to enable PEP 561
+  ([#3127](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3127))
 
 ### Fixed
 
 - `opentelemetry-instrumentation-httpx` Fix `RequestInfo`/`ResponseInfo` type hints
   ([#3105](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3105))
+- `opentelemetry-instrumentation-dbapi` Move `TracedCursorProxy` and `TracedConnectionProxy` to the module level
+  ([#3068](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3068))
+- `opentelemetry-instrumentation-click` Disable tracing of well-known server click commands
+  ([#3174](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3174))
+- `opentelemetry-instrumentation` Fix `get_dist_dependency_conflicts` if no distribution requires
+  ([#3168](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3168))
+
+### Breaking changes
+
+- `opentelemetry-instrumentation-sqlalchemy` including sqlcomment in `db.statement` span attribute value is now opt-in
+  ([#3112](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3112))
+
+### Breaking changes
+
+- `opentelemetry-instrumentation-dbapi` including sqlcomment in `db.statement` span attribute value is now opt-in
+  ([#3115](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3115))
+
+
+### Breaking changes
+
+- `opentelemetry-instrumentation-dbapi` including sqlcomment in `db.statement` span attribute value is now opt-in
+  ([#3115](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3115))
+- `opentelemetry-instrumentation-psycopg2`, `opentelemetry-instrumentation-psycopg`, `opentelemetry-instrumentation-mysqlclient`, `opentelemetry-instrumentation-pymysql`: including sqlcomment in `db.statement` span attribute value is now opt-in
+  ([#3121](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3121))
 
 
 ## Version 1.29.0/0.50b0 (2024-12-11)

README.md

@@ -48,6 +48,7 @@ The Python auto-instrumentation libraries for [OpenTelemetry](https://openteleme
 * [Installation](#installation)
 * [Releasing](#releasing)
   * [Releasing a package as `1.0` stable](#releasing-a-package-as-10-stable)
+* [Semantic Convention status of instrumentations](#semantic-convention-status-of-instrumentations)
 * [Contributing](#contributing)
 * [Thanks to all the people who already contributed](#thanks-to-all-the-people-who-already-contributed)
 
@@ -100,7 +101,7 @@ To release a package as `1.0` stable, the package:
 
 ## Semantic Convention status of instrumentations
 
-In our efforts to maintain optimal user experience and prevent breaking changes for transitioning into stable semantic conventions, OpenTelemetry Python is adopting the [semantic convention migration plan](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/migration-guide.md) for several instrumentations. Currently this plan is only being adopted for HTTP-related instrumentations, but will eventually cover all types. Please refer to the `semconv status` column of the [instrumentation README](instrumentation/README.md) of the current status of instrumentations' semantic conventions. The possible values are `experimental`, `stable` and `migration` referring to [status](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.31.0/specification/document-status.md#lifecycle-status) of that particular semantic convention. `Migration` refers to an instrumentation that currently supports the migration plan.
+In our efforts to maintain optimal user experience and prevent breaking changes for transitioning into stable semantic conventions, OpenTelemetry Python is adopting the semantic convention migration plan for several instrumentations. Currently this plan is only being adopted for [HTTP-related instrumentations](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/http-migration.md), but will eventually cover all types. Please refer to the `semconv status` column of the [instrumentation README](instrumentation/README.md) of the current status of instrumentations' semantic conventions. The possible values are `experimental`, `stable` and `migration` referring to [status](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.31.0/specification/document-status.md#lifecycle-status) of that particular semantic convention. `Migration` refers to an instrumentation that currently supports the migration plan.
 
 ## Contributing
 

dev-requirements.txt

@@ -1,6 +1,6 @@
 pylint==3.0.2
 httpretty==1.1.4
-mypy==0.931
+pyright==v1.1.390
 sphinx==7.1.2
 sphinx-rtd-theme==2.0.0rc4
 sphinx-autodoc-typehints==1.25.2

docs/nitpick-exceptions.ini

@@ -41,6 +41,7 @@ py-class=
     callable
     Consumer
     confluent_kafka.Message
+    ObjectProxy
 
 any=
     ; API
@@ -68,6 +69,8 @@ any=
 
 py-obj=
     opentelemetry.propagators.textmap.CarrierT
+    opentelemetry.instrumentation.dbapi.ConnectionT
+    opentelemetry.instrumentation.dbapi.CursorT
 
 py-func=
     poll

instrumentation/README.md

@@ -20,7 +20,7 @@
 | [opentelemetry-instrumentation-dbapi](./opentelemetry-instrumentation-dbapi) | dbapi | No | experimental
 | [opentelemetry-instrumentation-django](./opentelemetry-instrumentation-django) | django >= 1.10 | Yes | experimental
 | [opentelemetry-instrumentation-elasticsearch](./opentelemetry-instrumentation-elasticsearch) | elasticsearch >= 6.0 | No | experimental
-| [opentelemetry-instrumentation-falcon](./opentelemetry-instrumentation-falcon) | falcon >= 1.4.1, < 5.0.0 | Yes | experimental
+| [opentelemetry-instrumentation-falcon](./opentelemetry-instrumentation-falcon) | falcon >= 1.4.1, < 5.0.0 | Yes | migration
 | [opentelemetry-instrumentation-fastapi](./opentelemetry-instrumentation-fastapi) | fastapi ~= 0.58 | Yes | migration
 | [opentelemetry-instrumentation-flask](./opentelemetry-instrumentation-flask) | flask >= 1.0 | Yes | migration
 | [opentelemetry-instrumentation-grpc](./opentelemetry-instrumentation-grpc) | grpcio >= 1.42.0 | No | experimental

instrumentation/opentelemetry-instrumentation-asyncpg/tests/test_asyncpg_wrapper.py

@@ -5,6 +5,7 @@
 from asyncpg import Connection, Record, cursor
 from wrapt import ObjectProxy
 
+from opentelemetry import trace as trace_api
 from opentelemetry.instrumentation.asyncpg import AsyncPGInstrumentor
 from opentelemetry.test.test_base import TestBase
 
@@ -105,3 +106,36 @@ async def exec_mock(*args, **kwargs):
         spans = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(spans), 2)
         self.assertEqual([span.status.is_ok for span in spans], [True, True])
+
+    def test_no_op_tracer_provider(self):
+        AsyncPGInstrumentor().uninstrument()
+        AsyncPGInstrumentor().instrument(
+            tracer_provider=trace_api.NoOpTracerProvider()
+        )
+
+        # Mock out all interaction with postgres
+        async def bind_mock(*args, **kwargs):
+            return []
+
+        async def exec_mock(*args, **kwargs):
+            return [], None, True
+
+        conn = mock.Mock()
+        conn.is_closed = lambda: False
+
+        conn._protocol = mock.Mock()
+        conn._protocol.bind = bind_mock
+        conn._protocol.execute = exec_mock
+        conn._protocol.bind_execute = exec_mock
+        conn._protocol.close_portal = bind_mock
+
+        state = mock.Mock()
+        state.closed = False
+
+        # init the cursor and fetch a single record
+        crs = cursor.Cursor(conn, "SELECT * FROM test", state, [], Record)
+        asyncio.run(crs._init(1))
+        asyncio.run(crs.fetch(1))
+
+        spans = self.memory_exporter.get_finished_spans()
+        self.assertEqual(len(spans), 0)

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

@@ -13,7 +13,9 @@
 # limitations under the License.
 
 """
-Instrument `click`_ CLI applications.
+Instrument `click`_ CLI applications. The instrumentor will avoid instrumenting
+well-known servers (e.g. *flask run* and *uvicorn*) to avoid unexpected effects
+like every request having the same Trace ID.
 
 .. _click: https://pypi.org/project/click/
 
@@ -47,6 +49,12 @@ def hello():
 import click
 from wrapt import wrap_function_wrapper
 
+try:
+    from flask.cli import ScriptInfo as FlaskScriptInfo
+except ImportError:
+    FlaskScriptInfo = None
+
+
 from opentelemetry import trace
 from opentelemetry.instrumentation.click.package import _instruments
 from opentelemetry.instrumentation.click.version import __version__
@@ -66,6 +74,20 @@ def hello():
 _logger = getLogger(__name__)
 
 
+def _skip_servers(ctx: click.Context):
+    # flask run
+    if (
+        ctx.info_name == "run"
+        and FlaskScriptInfo
+        and isinstance(ctx.obj, FlaskScriptInfo)
+    ):
+        return True
+    # uvicorn
+    if ctx.info_name == "uvicorn":
+        return True
+    return False
+
+
 def _command_invoke_wrapper(wrapped, instance, args, kwargs, tracer):
     # Subclasses of Command include groups and CLI runners, but
     # we only want to instrument the actual commands which are
@@ -74,6 +96,12 @@ def _command_invoke_wrapper(wrapped, instance, args, kwargs, tracer):
         return wrapped(*args, **kwargs)
 
     ctx = args[0]
+
+    # we don't want to create a root span for long running processes like servers
+    # otherwise all requests would have the same trace id
+    if _skip_servers(ctx):
+        return wrapped(*args, **kwargs)
+
     span_name = ctx.info_name
     span_attributes = {
         PROCESS_COMMAND_ARGS: sys.argv,

instrumentation/opentelemetry-instrumentation-click/test-requirements.txt

@@ -1,15 +1,24 @@
 asgiref==3.8.1
+blinker==1.7.0
 click==8.1.7
 Deprecated==1.2.14
+Flask==3.0.2
 iniconfig==2.0.0
+itsdangerous==2.1.2
+Jinja2==3.1.4
+MarkupSafe==2.1.2
 packaging==24.0
 pluggy==1.5.0
 py-cpuinfo==9.0.0
 pytest==7.4.4
 pytest-asyncio==0.23.5
 tomli==2.0.1
 typing_extensions==4.12.2
+Werkzeug==3.0.6
 wrapt==1.16.0
 zipp==3.19.2
 -e opentelemetry-instrumentation
 -e instrumentation/opentelemetry-instrumentation-click
+-e instrumentation/opentelemetry-instrumentation-flask
+-e instrumentation/opentelemetry-instrumentation-wsgi
+-e util/opentelemetry-util-http

instrumentation/opentelemetry-instrumentation-click/tests/test_click.py

@@ -16,8 +16,14 @@
 from unittest import mock
 
 import click
+import pytest
 from click.testing import CliRunner
 
+try:
+    from flask import cli as flask_cli
+except ImportError:
+    flask_cli = None
+
 from opentelemetry.instrumentation.click import ClickInstrumentor
 from opentelemetry.test.test_base import TestBase
 from opentelemetry.trace import SpanKind
@@ -60,7 +66,7 @@ def command():
         )
 
     @mock.patch("sys.argv", ["flask", "command"])
-    def test_flask_run_command_wrapping(self):
+    def test_flask_command_wrapping(self):
         @click.command()
         def command():
             pass
@@ -162,6 +168,27 @@ def command_raises():
             },
         )
 
+    def test_uvicorn_cli_command_ignored(self):
+        @click.command("uvicorn")
+        def command_uvicorn():
+            pass
+
+        runner = CliRunner()
+        result = runner.invoke(command_uvicorn)
+        self.assertEqual(result.exit_code, 0)
+
+        self.assertFalse(self.memory_exporter.get_finished_spans())
+
+    @pytest.mark.skipif(flask_cli is None, reason="requires flask")
+    def test_flask_run_command_ignored(self):
+        runner = CliRunner()
+        result = runner.invoke(
+            flask_cli.run_command, obj=flask_cli.ScriptInfo()
+        )
+        self.assertEqual(result.exit_code, 2)
+
+        self.assertFalse(self.memory_exporter.get_finished_spans())
+
     def test_uninstrument(self):
         ClickInstrumentor().uninstrument()