Merge branch 'main' into mysqlconnector-sqlcomment-v4

Author: tammy-baylis-swi

.readthedocs.yml

@@ -12,4 +12,4 @@ build:
 
 python:
   install:
-    - requirements: docs-requirements.txt
+    - requirements: rtd-requirements.txt

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `opentelemetry-instrumentation-starlette` Add type hints to the instrumentation
+  ([#3045](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3045))
 - `opentelemetry-distro` default to OTLP log exporter.
   ([#3042](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3042))
 - `opentelemetry-instrumentation-sqlalchemy` Update unit tests to run with SQLALchemy 2
@@ -46,6 +48,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#3022](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3022))
 - Replace all instrumentor unit test `assertEqualSpanInstrumentationInfo` calls with `assertEqualSpanInstrumentationScope` calls
   ([#3037](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3037))
+- `opentelemetry-instrumentation-sqlalchemy` Fixes engines from `sqlalchemy.engine_from_config` not being fully instrumented
+  ([#2816](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2816))
+- `opentelemetry-instrumentation-sqlalchemy`: Fix a remaining memory leak in EngineTracer
+  ([#3053](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3053))
+- `opentelemetry-instrumentation-sqlite3`: Update documentation on explicit cursor support of tracing
+  ([#3088](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3088))
 
 ### Breaking changes
 

CONTRIBUTING.md

@@ -272,7 +272,11 @@ Below is a checklist of things to be mindful of when implementing a new instrume
 - Isolate sync and async test
   - For synchronous tests, the typical test case class is inherited from `opentelemetry.test.test_base.TestBase`. However, if you want to write asynchronous tests, the test case class should inherit also from `IsolatedAsyncioTestCase`. Adding asynchronous tests to a common test class can lead to tests passing without actually running, which can be misleading.
   - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/60fb936b7e5371b3e5587074906c49fb873cbd76/instrumentation/opentelemetry-instrumentation-grpc/tests/test_aio_server_interceptor.py#L84>
-- All instrumentations have the same version. If you are going to develop a new instrumentation it would probably have `X.Y.dev` version and depends on `opentelemetry-instrumentation` and `opentelemetry-semantic-conventions` for the same version. That means that if you want to install your instrumentation you need to install its dependencies from this repo and the core repo also from git.
+- Most of the instrumentations have the same version. If you are going to develop a new instrumentation it would probably have `X.Y.dev` version and depends on `opentelemetry-instrumentation` and `opentelemetry-semantic-conventions` for a [compatible version](https://peps.python.org/pep-0440/#compatible-release). That means that you may need to install the instrumentation dependencies from this repo and the core repo from git.
+- Documentation
+  - When adding a new instrumentation remember to add an entry in `docs/instrumentation/` named `<instrumentation>/<instrumentation>.rst` to have the instrumentation documentation referenced from the index. You can use the entry template available [here](./_template/autodoc_entry.rst)
+- Testing
+  - When adding a new instrumentation remember to update `tox.ini` adding appropriate rules in `envlist`, `command_pre` and `commands` sections
 
 ## Guideline for GenAI instrumentations
 

_template/autodoc_entry.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-<REPLACE ME>/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.<REPLACE ME>
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs-requirements.txt

@@ -2,14 +2,6 @@ sphinx==7.1.2
 sphinx-rtd-theme==2.0.0rc4
 sphinx-autodoc-typehints==1.25.2
 
-# Need to install the api/sdk in the venv for autodoc. Modifying sys.path
-# doesn't work for pkg_resources.
--e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-api&subdirectory=opentelemetry-api"
--e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-semantic-conventions&subdirectory=opentelemetry-semantic-conventions"
--e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-sdk&subdirectory=opentelemetry-sdk"
--e "git+https://github.com/open-telemetry/opentelemetry-python-contrib.git#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http"
-./opentelemetry-instrumentation
-
 # Required by opentelemetry-instrumentation
 fastapi>=0.65.2
 pymemcache~=1.3

docs/instrumentation/aiohttp_server/aiohttp_server.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-aiohttp-server/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.aiohttp_server
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/click/click.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-click/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.click
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/nitpick-exceptions.ini

@@ -29,6 +29,7 @@ py-class=
     httpx.SyncByteStream
     httpx.AsyncByteStream
     httpx.Response
+    aiohttp.web_request.Request
     yarl.URL
     cimpl.Producer
     cimpl.Consumer
@@ -65,7 +66,7 @@ any=
 
 py-obj=
     opentelemetry.propagators.textmap.CarrierT
-    
+
 py-func=
     poll
     flush

instrumentation-genai/opentelemetry-instrumentation-openai-v2/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Coerce openai response_format to semconv format
+  ([#3073](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3073))
 - Add example to `opentelemetry-instrumentation-openai-v2`
   ([#3006](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3006))
 - Support for `AsyncOpenAI/AsyncCompletions` ([#2984](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2984))

instrumentation-genai/opentelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/utils.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 from os import environ
-from typing import Optional, Union
+from typing import Mapping, Optional, Union
 from urllib.parse import urlparse
 
 from httpx import URL
@@ -202,12 +202,23 @@ def get_llm_request_attributes(
         GenAIAttributes.GEN_AI_REQUEST_FREQUENCY_PENALTY: kwargs.get(
             "frequency_penalty"
         ),
-        GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT: kwargs.get(
-            "response_format"
-        ),
         GenAIAttributes.GEN_AI_OPENAI_REQUEST_SEED: kwargs.get("seed"),
     }
 
+    if (response_format := kwargs.get("response_format")) is not None:
+        # response_format may be string or object with a string in the `type` key
+        if isinstance(response_format, Mapping):
+            if (
+                response_format_type := response_format.get("type")
+            ) is not None:
+                attributes[
+                    GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT
+                ] = response_format_type
+        else:
+            attributes[
+                GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT
+            ] = response_format
+
     set_server_address_and_port(client_instance, attributes)
     service_tier = kwargs.get("service_tier")
     attributes[GenAIAttributes.GEN_AI_OPENAI_RESPONSE_SERVICE_TIER] = (