opentelemetry-instrumentation 0.51b0__tar.gz → 0.52b0__tar.gz

{opentelemetry_instrumentation-0.51b0 → opentelemetry_instrumentation-0.52b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentelemetry-instrumentation
-Version: 0.51b0
+Version: 0.52b0
 Summary: Instrumentation Tools & Auto Instrumentation for OpenTelemetry Python
 Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation
 Project-URL: Repository, https://github.com/open-telemetry/opentelemetry-python-contrib
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Requires-Dist: opentelemetry-api~=1.4
-Requires-Dist: opentelemetry-semantic-conventions==0.51b0
+Requires-Dist: opentelemetry-semantic-conventions==0.52b0
 Requires-Dist: packaging>=18.0
 Requires-Dist: wrapt<2.0.0,>=1.0.0
 Description-Content-Type: text/x-rst
@@ -157,6 +157,19 @@ start celery with the rest of the arguments.
 The above command will configure the global trace provider to use the Random IDs Generator, and then
 pass ``--port=3000`` to ``flask run``.
 
+Programmatic Auto-instrumentation
+---------------------------------
+
+::
+
+    from opentelemetry.instrumentation import auto_instrumentation
+    auto_instrumentation.initialize()
+
+
+If you are in an environment where you cannot use opentelemetry-instrument to inject auto-instrumentation you can do so programmatically with
+the code above. Please note that some instrumentations may require the ``initialize()`` method to be called before the library they
+instrument is imported.
+
 References
 ----------
 

{opentelemetry_instrumentation-0.51b0 → opentelemetry_instrumentation-0.52b0}/README.rst

@@ -130,6 +130,19 @@ start celery with the rest of the arguments.
 The above command will configure the global trace provider to use the Random IDs Generator, and then
 pass ``--port=3000`` to ``flask run``.
 
+Programmatic Auto-instrumentation
+---------------------------------
+
+::
+
+    from opentelemetry.instrumentation import auto_instrumentation
+    auto_instrumentation.initialize()
+
+
+If you are in an environment where you cannot use opentelemetry-instrument to inject auto-instrumentation you can do so programmatically with
+the code above. Please note that some instrumentations may require the ``initialize()`` method to be called before the library they
+instrument is imported.
+
 References
 ----------
 

{opentelemetry_instrumentation-0.51b0 → opentelemetry_instrumentation-0.52b0}/pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 ]
 dependencies = [
   "opentelemetry-api ~= 1.4",
-  "opentelemetry-semantic-conventions == 0.51b0",
+  "opentelemetry-semantic-conventions == 0.52b0",
   "wrapt >= 1.0.0, < 2.0.0",
   "packaging >= 18.0",
 ]

{opentelemetry_instrumentation-0.51b0 → opentelemetry_instrumentation-0.52b0}/src/opentelemetry/instrumentation/auto_instrumentation/__init__.py

@@ -19,6 +19,12 @@ from os.path import abspath, dirname, pathsep
 from re import sub
 from shutil import which
 
+from opentelemetry.instrumentation.auto_instrumentation._load import (
+    _load_configurators,
+    _load_distro,
+    _load_instrumentors,
+)
+from opentelemetry.instrumentation.utils import _python_path_without_directory
 from opentelemetry.instrumentation.version import __version__
 from opentelemetry.util._importlib_metadata import entry_points
 
@@ -110,3 +116,20 @@ def run() -> None:
 
     executable = which(args.command)
     execl(executable, executable, *args.command_args)
+
+
+def initialize():
+    """Setup auto-instrumentation, called by the sitecustomize module"""
+    # prevents auto-instrumentation of subprocesses if code execs another python process
+    if "PYTHONPATH" in environ:
+        environ["PYTHONPATH"] = _python_path_without_directory(
+            environ["PYTHONPATH"], dirname(abspath(__file__)), pathsep
+        )
+
+    try:
+        distro = _load_distro()
+        distro.configure()
+        _load_configurators()
+        _load_instrumentors(distro)
+    except Exception:  # pylint: disable=broad-except
+        _logger.exception("Failed to auto initialize OpenTelemetry")

opentelemetry_instrumentation-0.52b0/src/opentelemetry/instrumentation/auto_instrumentation/sitecustomize.py

@@ -0,0 +1,17 @@
+# 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.auto_instrumentation import initialize
+
+initialize()

{opentelemetry_instrumentation-0.51b0 → opentelemetry_instrumentation-0.52b0}/src/opentelemetry/instrumentation/bootstrap_gen.py

@@ -18,203 +18,203 @@
 libraries = [
     {
         "library": "openai >= 1.26.0",
-        "instrumentation": "opentelemetry-instrumentation-openai-v2==2.2b0.dev",
+        "instrumentation": "opentelemetry-instrumentation-openai-v2",
     },
     {
         "library": "google-cloud-aiplatform >= 1.64",
-        "instrumentation": "opentelemetry-instrumentation-vertexai==2.1b0.dev",
+        "instrumentation": "opentelemetry-instrumentation-vertexai>=2.0b0",
     },
     {
         "library": "aio_pika >= 7.2.0, < 10.0.0",
-        "instrumentation": "opentelemetry-instrumentation-aio-pika==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-aio-pika==0.52b0",
     },
     {
         "library": "aiohttp ~= 3.0",
-        "instrumentation": "opentelemetry-instrumentation-aiohttp-client==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-aiohttp-client==0.52b0",
     },
     {
         "library": "aiohttp ~= 3.0",
-        "instrumentation": "opentelemetry-instrumentation-aiohttp-server==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-aiohttp-server==0.52b0",
     },
     {
         "library": "aiokafka >= 0.8, < 1.0",
-        "instrumentation": "opentelemetry-instrumentation-aiokafka==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-aiokafka==0.52b0",
     },
     {
         "library": "aiopg >= 0.13.0, < 2.0.0",
-        "instrumentation": "opentelemetry-instrumentation-aiopg==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-aiopg==0.52b0",
     },
     {
         "library": "asgiref ~= 3.0",
-        "instrumentation": "opentelemetry-instrumentation-asgi==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-asgi==0.52b0",
     },
     {
         "library": "asyncpg >= 0.12.0",
-        "instrumentation": "opentelemetry-instrumentation-asyncpg==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-asyncpg==0.52b0",
     },
     {
         "library": "boto~=2.0",
-        "instrumentation": "opentelemetry-instrumentation-boto==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-boto==0.52b0",
     },
     {
         "library": "boto3 ~= 1.0",
-        "instrumentation": "opentelemetry-instrumentation-boto3sqs==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-boto3sqs==0.52b0",
     },
     {
         "library": "botocore ~= 1.0",
-        "instrumentation": "opentelemetry-instrumentation-botocore==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-botocore==0.52b0",
     },
     {
         "library": "cassandra-driver ~= 3.25",
-        "instrumentation": "opentelemetry-instrumentation-cassandra==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-cassandra==0.52b0",
     },
     {
         "library": "scylla-driver ~= 3.25",
-        "instrumentation": "opentelemetry-instrumentation-cassandra==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-cassandra==0.52b0",
     },
     {
         "library": "celery >= 4.0, < 6.0",
-        "instrumentation": "opentelemetry-instrumentation-celery==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-celery==0.52b0",
     },
     {
         "library": "click >= 8.1.3, < 9.0.0",
-        "instrumentation": "opentelemetry-instrumentation-click==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-click==0.52b0",
     },
     {
         "library": "confluent-kafka >= 1.8.2, <= 2.7.0",
-        "instrumentation": "opentelemetry-instrumentation-confluent-kafka==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-confluent-kafka==0.52b0",
     },
     {
         "library": "django >= 1.10",
-        "instrumentation": "opentelemetry-instrumentation-django==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-django==0.52b0",
     },
     {
         "library": "elasticsearch >= 6.0",
-        "instrumentation": "opentelemetry-instrumentation-elasticsearch==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-elasticsearch==0.52b0",
     },
     {
         "library": "falcon >= 1.4.1, < 5.0.0",
-        "instrumentation": "opentelemetry-instrumentation-falcon==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-falcon==0.52b0",
     },
     {
         "library": "fastapi ~= 0.58",
-        "instrumentation": "opentelemetry-instrumentation-fastapi==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-fastapi==0.52b0",
     },
     {
         "library": "flask >= 1.0",
-        "instrumentation": "opentelemetry-instrumentation-flask==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-flask==0.52b0",
     },
     {
         "library": "grpcio >= 1.42.0",
-        "instrumentation": "opentelemetry-instrumentation-grpc==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-grpc==0.52b0",
     },
     {
         "library": "httpx >= 0.18.0",
-        "instrumentation": "opentelemetry-instrumentation-httpx==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-httpx==0.52b0",
     },
     {
         "library": "jinja2 >= 2.7, < 4.0",
-        "instrumentation": "opentelemetry-instrumentation-jinja2==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-jinja2==0.52b0",
     },
     {
         "library": "kafka-python >= 2.0, < 3.0",
-        "instrumentation": "opentelemetry-instrumentation-kafka-python==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-kafka-python==0.52b0",
     },
     {
         "library": "kafka-python-ng >= 2.0, < 3.0",
-        "instrumentation": "opentelemetry-instrumentation-kafka-python==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-kafka-python==0.52b0",
     },
     {
         "library": "mysql-connector-python >= 8.0, < 10.0",
-        "instrumentation": "opentelemetry-instrumentation-mysql==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-mysql==0.52b0",
     },
     {
         "library": "mysqlclient < 3",
-        "instrumentation": "opentelemetry-instrumentation-mysqlclient==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-mysqlclient==0.52b0",
     },
     {
         "library": "pika >= 0.12.0",
-        "instrumentation": "opentelemetry-instrumentation-pika==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-pika==0.52b0",
     },
     {
         "library": "psycopg >= 3.1.0",
-        "instrumentation": "opentelemetry-instrumentation-psycopg==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-psycopg==0.52b0",
     },
     {
         "library": "psycopg2 >= 2.7.3.1",
-        "instrumentation": "opentelemetry-instrumentation-psycopg2==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-psycopg2==0.52b0",
     },
     {
         "library": "psycopg2-binary >= 2.7.3.1",
-        "instrumentation": "opentelemetry-instrumentation-psycopg2==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-psycopg2==0.52b0",
     },
     {
         "library": "pymemcache >= 1.3.5, < 5",
-        "instrumentation": "opentelemetry-instrumentation-pymemcache==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-pymemcache==0.52b0",
     },
     {
         "library": "pymongo >= 3.1, < 5.0",
-        "instrumentation": "opentelemetry-instrumentation-pymongo==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-pymongo==0.52b0",
     },
     {
         "library": "pymssql >= 2.1.5, < 3",
-        "instrumentation": "opentelemetry-instrumentation-pymssql==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-pymssql==0.52b0",
     },
     {
         "library": "PyMySQL < 2",
-        "instrumentation": "opentelemetry-instrumentation-pymysql==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-pymysql==0.52b0",
     },
     {
         "library": "pyramid >= 1.7",
-        "instrumentation": "opentelemetry-instrumentation-pyramid==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-pyramid==0.52b0",
     },
     {
         "library": "redis >= 2.6",
-        "instrumentation": "opentelemetry-instrumentation-redis==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-redis==0.52b0",
     },
     {
         "library": "remoulade >= 0.50",
-        "instrumentation": "opentelemetry-instrumentation-remoulade==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-remoulade==0.52b0",
     },
     {
         "library": "requests ~= 2.0",
-        "instrumentation": "opentelemetry-instrumentation-requests==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-requests==0.52b0",
     },
     {
         "library": "sqlalchemy >= 1.0.0, < 2.1.0",
-        "instrumentation": "opentelemetry-instrumentation-sqlalchemy==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-sqlalchemy==0.52b0",
     },
     {
-        "library": "starlette ~= 0.13.0",
-        "instrumentation": "opentelemetry-instrumentation-starlette==0.51b0",
+        "library": "starlette >= 0.13, <0.15",
+        "instrumentation": "opentelemetry-instrumentation-starlette==0.52b0",
     },
     {
         "library": "psutil >= 5",
-        "instrumentation": "opentelemetry-instrumentation-system-metrics==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-system-metrics==0.52b0",
     },
     {
         "library": "tornado >= 5.1.1",
-        "instrumentation": "opentelemetry-instrumentation-tornado==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-tornado==0.52b0",
     },
     {
         "library": "tortoise-orm >= 0.17.0",
-        "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.52b0",
     },
     {
         "library": "pydantic >= 1.10.2",
-        "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.52b0",
     },
     {
         "library": "urllib3 >= 1.0.0, < 3.0.0",
-        "instrumentation": "opentelemetry-instrumentation-urllib3==0.51b0",
+        "instrumentation": "opentelemetry-instrumentation-urllib3==0.52b0",
     },
 ]
 default_instrumentations = [
-    "opentelemetry-instrumentation-asyncio==0.51b0",
-    "opentelemetry-instrumentation-dbapi==0.51b0",
-    "opentelemetry-instrumentation-logging==0.51b0",
-    "opentelemetry-instrumentation-sqlite3==0.51b0",
-    "opentelemetry-instrumentation-threading==0.51b0",
-    "opentelemetry-instrumentation-urllib==0.51b0",
-    "opentelemetry-instrumentation-wsgi==0.51b0",
+    "opentelemetry-instrumentation-asyncio==0.52b0",
+    "opentelemetry-instrumentation-dbapi==0.52b0",
+    "opentelemetry-instrumentation-logging==0.52b0",
+    "opentelemetry-instrumentation-sqlite3==0.52b0",
+    "opentelemetry-instrumentation-threading==0.52b0",
+    "opentelemetry-instrumentation-urllib==0.52b0",
+    "opentelemetry-instrumentation-wsgi==0.52b0",
 ]

{opentelemetry_instrumentation-0.51b0 → opentelemetry_instrumentation-0.52b0}/src/opentelemetry/instrumentation/version.py

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

opentelemetry_instrumentation-0.52b0/tests/auto_instrumentation/test_initialize.py

@@ -0,0 +1,61 @@
+# 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.
+# type: ignore
+
+from os import environ
+from os.path import abspath, dirname, pathsep
+from unittest import TestCase
+from unittest.mock import patch
+
+from opentelemetry.instrumentation import auto_instrumentation
+
+# TODO: convert to assertNoLogs instead of mocking logger when 3.10 is baseline
+
+
+class TestInitialize(TestCase):
+    auto_instrumentation_path = dirname(abspath(auto_instrumentation.__file__))
+
+    @patch.dict("os.environ", {}, clear=True)
+    @patch("opentelemetry.instrumentation.auto_instrumentation._logger")
+    def test_handles_pythonpath_not_set(self, logger_mock):
+        auto_instrumentation.initialize()
+        self.assertNotIn("PYTHONPATH", environ)
+        logger_mock.exception.assert_not_called()
+
+    @patch.dict("os.environ", {"PYTHONPATH": "."})
+    @patch("opentelemetry.instrumentation.auto_instrumentation._logger")
+    def test_handles_pythonpath_set(self, logger_mock):
+        auto_instrumentation.initialize()
+        self.assertEqual(environ["PYTHONPATH"], ".")
+        logger_mock.exception.assert_not_called()
+
+    @patch.dict(
+        "os.environ",
+        {"PYTHONPATH": auto_instrumentation_path + pathsep + "foo"},
+    )
+    @patch("opentelemetry.instrumentation.auto_instrumentation._logger")
+    def test_clears_auto_instrumentation_path(self, logger_mock):
+        auto_instrumentation.initialize()
+        self.assertEqual(environ["PYTHONPATH"], "foo")
+        logger_mock.exception.assert_not_called()
+
+    @patch("opentelemetry.instrumentation.auto_instrumentation._logger")
+    @patch("opentelemetry.instrumentation.auto_instrumentation._load_distro")
+    def test_handles_exceptions(self, load_distro_mock, logger_mock):
+        # pylint:disable=no-self-use
+        load_distro_mock.side_effect = ValueError
+        auto_instrumentation.initialize()
+        logger_mock.exception.assert_called_once_with(
+            "Failed to auto initialize OpenTelemetry"
+        )

opentelemetry_instrumentation-0.52b0/tests/auto_instrumentation/test_sitecustomize.py

@@ -0,0 +1,28 @@
+# 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.
+# type: ignore
+
+from unittest import TestCase
+from unittest.mock import patch
+
+
+class TestSiteCustomize(TestCase):
+    # pylint:disable=import-outside-toplevel,unused-import,no-self-use
+    @patch("opentelemetry.instrumentation.auto_instrumentation.initialize")
+    def test_sitecustomize_side_effects(self, initialize_mock):
+        initialize_mock.assert_not_called()
+
+        import opentelemetry.instrumentation.auto_instrumentation.sitecustomize  # NOQA
+
+        initialize_mock.assert_called_once()

opentelemetry_instrumentation-0.51b0/src/opentelemetry/instrumentation/auto_instrumentation/sitecustomize.py

@@ -1,44 +0,0 @@
-# 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 logging import getLogger
-from os import environ
-from os.path import abspath, dirname, pathsep
-
-from opentelemetry.instrumentation.auto_instrumentation._load import (
-    _load_configurators,
-    _load_distro,
-    _load_instrumentors,
-)
-from opentelemetry.instrumentation.utils import _python_path_without_directory
-
-logger = getLogger(__name__)
-
-
-def initialize():
-    # prevents auto-instrumentation of subprocesses if code execs another python process
-    environ["PYTHONPATH"] = _python_path_without_directory(
-        environ["PYTHONPATH"], dirname(abspath(__file__)), pathsep
-    )
-
-    try:
-        distro = _load_distro()
-        distro.configure()
-        _load_configurators()
-        _load_instrumentors(distro)
-    except Exception:  # pylint: disable=broad-except
-        logger.exception("Failed to auto initialize opentelemetry")
-
-
-initialize()