Merge branch 'main' into add-type-hints-to-dbapi

Author: Kludex

CHANGELOG.md

@@ -11,6 +11,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- `opentelemetry-instrumentation-confluent-kafka` Add support for confluent-kafka <=2.7.0
+  ([#3100](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3100))
+- Add support to database stability opt-in in `_semconv` utilities and add tests
+  ([#3111](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3111))
+
+### 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))
 

CONTRIBUTING.md

@@ -63,7 +63,7 @@ You can run `tox` with the following arguments:
 
 * `tox` to run all existing tox commands, including unit tests for all packages
   under multiple Python versions
-* `tox -e docs` to regenerate the API docs
+* `tox -e docs` to regenerate all docs
 * `tox -e py312-test-instrumentation-aiopg` to e.g. run the aiopg instrumentation unit tests under a specific
   Python version
 * `tox -e spellcheck` to run a spellcheck on all the code
@@ -89,7 +89,9 @@ for more detail on available tox commands.
 
 ### Troubleshooting
 
-> Some packages may require additional system wide dependencies to be installed. For example, you may need to install `libpq-dev` to run the postgresql client libraries instrumentation tests. or `libsnappy-dev` to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for.
+Some packages may require additional system-wide dependencies to be installed. For example, you may need to install `libpq-dev` to run the postgresql client libraries instrumentation tests or `libsnappy-dev` to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for. 
+
+For `docs` building, you may need to install `mysql-client` and other required dependencies as necessary. Ensure the Python version used in your local setup matches the version used in the [CI](./.github/workflows/) to maintain compatibility when building the documentation.
 
 ### Benchmarks
 
@@ -278,6 +280,20 @@ Below is a checklist of things to be mindful of when implementing a new instrume
 - Testing
   - When adding a new instrumentation remember to update `tox.ini` adding appropriate rules in `envlist`, `command_pre` and `commands` sections
 
+### Update supported instrumentation package versions
+
+- Navigate to the **instrumentation package directory:**
+  - Update **`pyproject.toml`** file by modifying _instruments_ entry in the `[project.optional-dependencies]` section with the new version constraint
+  - Update `_instruments` variable in instrumentation **`package.py`** file with the new version constraint
+- At the **root of the project directory**, run `tox -e generate` to regenerate necessary files
+
+If you're adding support for a new version of the instrumentation package, follow these additional steps:
+
+- At the **instrumentation package directory:** Add new test-requirements.txt file with the respective package version required for testing
+- At the **root of the project directory**: Add a new test environment entry for the package version in [tox.ini](./tox.ini) and run `tox -e generate-workflows` to regenerate new workflows accordingly. In the same [tox.ini](./tox.ini) file, search for `opentelemetry-instrumentation-{package}/test-requirements` and add a new line to point to the new test-requirements.txt you created in the previous step so tox can install the correct requirements.
+
+Example PRs: [#2976](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2976), [#2845](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2845)
+
 ## Guideline for GenAI instrumentations
 
 Instrumentations that relate to [Generative AI](https://opentelemetry.io/docs/specs/semconv/gen-ai/) systems will be placed in the [instrumentation-genai](./instrumentation-genai) folder. This section covers contributions related to those instrumentations. Please note that the [guidelines for instrumentations](#guideline-for-instrumentations) and [expectations from contributors](#expectations-from-contributors) still apply.

dev-requirements.txt

@@ -8,7 +8,6 @@ pytest==7.4.4
 pytest-cov==4.1.0
 readme-renderer==42.0
 bleach==4.1.0 # transient dependency for readme-renderer
-protobuf~=3.13
 markupsafe>=2.0.1
 codespell==2.1.0
 requests==2.32.3

docs/nitpick-exceptions.ini

@@ -29,6 +29,8 @@ py-class=
     httpx.SyncByteStream
     httpx.AsyncByteStream
     httpx.Response
+    httpx.URL
+    httpx.Headers
     aiohttp.web_request.Request
     yarl.URL
     cimpl.Producer

instrumentation-genai/opentelemetry-instrumentation-openai-v2/examples/manual/requirements.txt

@@ -1,5 +1,5 @@
-openai~=1.54.4
+openai~=1.57.3
 
-opentelemetry-sdk~=1.28.2
-opentelemetry-exporter-otlp-proto-grpc~=1.28.2
+opentelemetry-sdk~=1.29.0
+opentelemetry-exporter-otlp-proto-grpc~=1.29.0
 opentelemetry-instrumentation-openai-v2~=2.0b0

instrumentation-genai/opentelemetry-instrumentation-openai-v2/examples/zero-code/requirements.txt

@@ -1,6 +1,6 @@
-openai~=1.54.4
+openai~=1.57.3
 
-opentelemetry-sdk~=1.28.2
-opentelemetry-exporter-otlp-proto-grpc~=1.28.2
-opentelemetry-distro~=0.49b2
+opentelemetry-sdk~=1.29.0
+opentelemetry-exporter-otlp-proto-grpc~=1.29.0
+opentelemetry-distro~=0.50b0
 opentelemetry-instrumentation-openai-v2~=2.0b0

instrumentation/README.md

@@ -16,7 +16,7 @@
 | [opentelemetry-instrumentation-cassandra](./opentelemetry-instrumentation-cassandra) | cassandra-driver ~= 3.25,scylla-driver ~= 3.25 | No | experimental
 | [opentelemetry-instrumentation-celery](./opentelemetry-instrumentation-celery) | celery >= 4.0, < 6.0 | No | experimental
 | [opentelemetry-instrumentation-click](./opentelemetry-instrumentation-click) | click >= 8.1.3, < 9.0.0 | No | experimental
-| [opentelemetry-instrumentation-confluent-kafka](./opentelemetry-instrumentation-confluent-kafka) | confluent-kafka >= 1.8.2, <= 2.4.0 | No | experimental
+| [opentelemetry-instrumentation-confluent-kafka](./opentelemetry-instrumentation-confluent-kafka) | confluent-kafka >= 1.8.2, <= 2.7.0 | No | experimental
 | [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

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py

@@ -92,13 +92,13 @@ def response_hook(span: Span, params: typing.Union[
 from opentelemetry import trace
 from opentelemetry.instrumentation._semconv import (
     _get_schema_url,
-    _HTTPStabilityMode,
     _OpenTelemetrySemanticConventionStability,
     _OpenTelemetryStabilitySignalType,
     _report_new,
     _set_http_method,
     _set_http_url,
     _set_status,
+    _StabilityMode,
 )
 from opentelemetry.instrumentation.aiohttp_client.package import _instruments
 from opentelemetry.instrumentation.aiohttp_client.version import __version__
@@ -142,7 +142,7 @@ def _set_http_status_code_attribute(
     span,
     status_code,
     metric_attributes=None,
-    sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT,
+    sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
 ):
     status_code_str = str(status_code)
     try:
@@ -169,7 +169,7 @@ def create_trace_config(
     request_hook: _RequestHookT = None,
     response_hook: _ResponseHookT = None,
     tracer_provider: TracerProvider = None,
-    sem_conv_opt_in_mode: _HTTPStabilityMode = _HTTPStabilityMode.DEFAULT,
+    sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
 ) -> aiohttp.TraceConfig:
     """Create an aiohttp-compatible trace configuration.
 
@@ -326,7 +326,7 @@ def _instrument(
     trace_configs: typing.Optional[
         typing.Sequence[aiohttp.TraceConfig]
     ] = None,
-    sem_conv_opt_in_mode: _HTTPStabilityMode = _HTTPStabilityMode.DEFAULT,
+    sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
 ):
     """Enables tracing of all ClientSessions
 

instrumentation/opentelemetry-instrumentation-aiohttp-client/tests/test_aiohttp_client_integration.py

@@ -29,8 +29,8 @@
 from opentelemetry.instrumentation import aiohttp_client
 from opentelemetry.instrumentation._semconv import (
     OTEL_SEMCONV_STABILITY_OPT_IN,
-    _HTTPStabilityMode,
     _OpenTelemetrySemanticConventionStability,
+    _StabilityMode,
 )
 from opentelemetry.instrumentation.aiohttp_client import (
     AioHttpClientInstrumentor,
@@ -150,7 +150,7 @@ def test_status_codes_new_semconv(self):
                 path = "test-path?query=param#foobar"
                 host, port = self._http_request(
                     trace_config=aiohttp_client.create_trace_config(
-                        sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
+                        sem_conv_opt_in_mode=_StabilityMode.HTTP
                     ),
                     url=f"/{path}",
                     status_code=status_code,
@@ -173,7 +173,7 @@ def test_status_codes_both_semconv(self):
                 path = "test-path?query=param#foobar"
                 host, port = self._http_request(
                     trace_config=aiohttp_client.create_trace_config(
-                        sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP_DUP
+                        sem_conv_opt_in_mode=_StabilityMode.HTTP_DUP
                     ),
                     url=f"/{path}",
                     status_code=status_code,
@@ -213,7 +213,7 @@ def test_schema_url_new_semconv(self):
         with self.subTest(status_code=200):
             self._http_request(
                 trace_config=aiohttp_client.create_trace_config(
-                    sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
+                    sem_conv_opt_in_mode=_StabilityMode.HTTP
                 ),
                 url="/test-path?query=param#foobar",
                 status_code=200,
@@ -230,7 +230,7 @@ def test_schema_url_both_semconv(self):
         with self.subTest(status_code=200):
             self._http_request(
                 trace_config=aiohttp_client.create_trace_config(
-                    sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP_DUP
+                    sem_conv_opt_in_mode=_StabilityMode.HTTP_DUP
                 ),
                 url="/test-path?query=param#foobar",
                 status_code=200,
@@ -398,7 +398,7 @@ async def request_handler(request):
 
         host, port = self._http_request(
             trace_config=aiohttp_client.create_trace_config(
-                sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
+                sem_conv_opt_in_mode=_StabilityMode.HTTP
             ),
             url="/test",
             request_handler=request_handler,
@@ -426,7 +426,7 @@ async def request_handler(request):
 
         host, port = self._http_request(
             trace_config=aiohttp_client.create_trace_config(
-                sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP_DUP
+                sem_conv_opt_in_mode=_StabilityMode.HTTP_DUP
             ),
             url="/test",
             request_handler=request_handler,
@@ -546,7 +546,7 @@ async def do_request(url):
     def test_nonstandard_http_method_new_semconv(self):
         trace_configs = [
             aiohttp_client.create_trace_config(
-                sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
+                sem_conv_opt_in_mode=_StabilityMode.HTTP
             )
         ]
         app = HttpServerMock("nonstandard_method")

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

@@ -205,7 +205,6 @@ def client_response_hook(span: Span, scope: dict[str, Any], message: dict[str, A
     _filter_semconv_active_request_count_attr,
     _filter_semconv_duration_attrs,
     _get_schema_url,
-    _HTTPStabilityMode,
     _OpenTelemetrySemanticConventionStability,
     _OpenTelemetryStabilitySignalType,
     _report_new,
@@ -225,6 +224,7 @@ def client_response_hook(span: Span, scope: dict[str, Any], message: dict[str, A
     _set_http_url,
     _set_http_user_agent,
     _set_status,
+    _StabilityMode,
 )
 from opentelemetry.instrumentation.asgi.types import (
     ClientRequestHook,
@@ -324,7 +324,7 @@ def set(self, carrier: dict, key: str, value: str) -> None:  # pylint: disable=n
 
 # pylint: disable=too-many-branches
 def collect_request_attributes(
-    scope, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
+    scope, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
 ):
     """Collects HTTP request attributes from the ASGI scope and returns a
     dictionary to be used as span creation attributes."""
@@ -356,7 +356,7 @@ def collect_request_attributes(
             _set_http_url(
                 result,
                 remove_url_credentials(http_url),
-                _HTTPStabilityMode.DEFAULT,
+                _StabilityMode.DEFAULT,
             )
     http_method = scope.get("method", "")
     if http_method:
@@ -439,7 +439,7 @@ def set_status_code(
     span,
     status_code,
     metric_attributes=None,
-    sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT,
+    sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
 ):
     """Adds HTTP response attributes to span using the status_code argument."""
     status_code_str = str(status_code)
@@ -755,12 +755,12 @@ async def __call__(
                     )
                 duration_s = default_timer() - start
                 duration_attrs_old = _parse_duration_attrs(
-                    attributes, _HTTPStabilityMode.DEFAULT
+                    attributes, _StabilityMode.DEFAULT
                 )
                 if target:
                     duration_attrs_old[SpanAttributes.HTTP_TARGET] = target
                 duration_attrs_new = _parse_duration_attrs(
-                    attributes, _HTTPStabilityMode.HTTP
+                    attributes, _StabilityMode.HTTP
                 )
                 if self.duration_histogram_old:
                     self.duration_histogram_old.record(
@@ -960,7 +960,7 @@ async def otel_send(message: dict[str, Any]):
 
 
 def _parse_duration_attrs(
-    req_attrs, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
+    req_attrs, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
 ):
     return _filter_semconv_duration_attrs(
         req_attrs,
@@ -971,7 +971,7 @@ def _parse_duration_attrs(
 
 
 def _parse_active_request_count_attrs(
-    req_attrs, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
+    req_attrs, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
 ):
     return _filter_semconv_active_request_count_attr(
         req_attrs,