Merge branch 'main' into feat/openai-responses-create-instrumentation-first-part

Author: eternalcuriouslearner

CHANGELOG.md

@@ -26,6 +26,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4427](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4427))
 - `opentelemetry-instrumentation-flask`: Clean up environ keys in `_teardown_request` to prevent duplicate execution
   ([#4341](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4341))
+- `opentelemetry-instrumentation-flask`: Stop reading the deprecated (from 3.1) `flask.__version__` attribute; resolve the Flask version via `importlib.metadata`
+  ([#4422](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4422))
+- `opentelemetry-instrumentation-celery`: Coerce non-string values to strings in `CeleryGetter.get()` to prevent `TypeError` in `TraceState.from_header()` when Celery request attributes contain ints
+  ([#4360](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4360))
+- `opentelemetry-instrumentation-aiohttp-server`: Use `canonical` attribute of the `Resource` as a span name
+  ([#3896](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3896))
 
 ### Breaking changes
 
@@ -51,8 +57,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- `opentelemetry-instrumentation-celery`: Coerce non-string values to strings in `CeleryGetter.get()` to prevent `TypeError` in `TraceState.from_header()` when Celery request attributes contain ints
-  ([#4360](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4360))
 - `opentelemetry-docker-tests`: Replace deprecated `SpanAttributes` from `opentelemetry.semconv.trace` with `opentelemetry.semconv._incubating.attributes`
  ([#4339](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4339))
 - `opentelemetry-instrumentation-confluent-kafka`: Skip `recv` span creation when `poll()` returns no message or `consume()` returns an empty list, avoiding empty spans on idle polls

CONTRIBUTING.md

@@ -42,6 +42,7 @@ Please also read the [OpenTelemetry Contributor Guide](https://github.com/open-t
   - [Guideline for GenAI instrumentations](#guideline-for-genai-instrumentations)
     - [Get Involved](#get-involved)
   - [Expectations from contributors](#expectations-from-contributors)
+    - [Guidelines for native OpenTelemetry instrumentation](#guidelines-for-native-opentelemetry-instrumentation)
   - [Updating supported Python versions](#updating-supported-python-versions)
     - [Bumping the Python baseline](#bumping-the-python-baseline)
     - [Adding support for a new Python release](#adding-support-for-a-new-python-release)
@@ -293,7 +294,7 @@ Some of the tox targets install packages from the [OpenTelemetry Python Core Rep
 CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
 ```
 
-The continuous integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test_0.yml#L14).
+The continuous integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test.yml#L17).
 
 ## Style Guide
 
@@ -307,6 +308,9 @@ The continuous integration overrides that environment variable with as per the c
 
 Below is a checklist of things to be mindful of when implementing a new instrumentation or working on a specific instrumentation. It is one of our goals as a community to keep the implementation specific details of instrumentations as similar across the board as possible for ease of testing and feature parity. It is also good to abstract as much common functionality as possible.
 
+- Find or create a new [Issue](https://github.com/open-telemetry/opentelemetry-python-contrib/issues) describing the tool or framework to instrument and its use cases to support with OpenTelemetry.
+  - Be familiar with the [expectations from contributors](#expectations-from-contributors) that apply.
+  - If you're a tool or framework maintainer, please consider using the OpenTelemetry API directly to support [native instrumentation](#guidelines-for-native-opentelemetry-instrumentation) instead of adding a new community instrumentation library.
 - Follow semantic conventions
   - The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
   - To ensure consistency, we encourage contributions that align with [STABLE](https://opentelemetry.io/docs/specs/otel/document-status/#lifecycle-status) semantic conventions if available. This approach helps us avoid potential confusion and reduces the need to support multiple outdated versions of semantic conventions. However, we are still open to considering exceptional cases where changes are well justified.
@@ -384,6 +388,16 @@ Instrumentations that relate to [Generative AI](https://opentelemetry.io/docs/sp
 
 OpenTelemetry is an open source community, and as such, greatly encourages contributions from anyone interested in the project. With that being said, there is a certain level of expectation from contributors even after a pull request is merged, specifically pertaining to instrumentations. The OpenTelemetry Python community expects contributors to maintain a level of support and interest in the instrumentations they contribute. This is to ensure that the instrumentation does not become stale and still functions the way the original contributor intended. Some instrumentations also pertain to libraries that the current members of the community are not so familiar with, so it is necessary to rely on the expertise of the original contributing parties.
 
+### Guidelines for native OpenTelemetry instrumentation
+
+The preferred approach to supporting instrumentation of a tool or framework is native OpenTelemetry instrumentation. Compared to adding a new instrumentation library to this community repository, native instrumentation is better for:
+
+* continued support by framework experts long-term
+* access to more context for critical paths and correlations
+* granularity and performance
+
+To support native instrumentation, the tool or framework should use the [OpenTelemetry API](https://opentelemetry-python.readthedocs.io/en/latest/) directly to emit traces, metrics, and logs.
+
 ## Updating supported Python versions
 
 ### Bumping the Python baseline

docs-requirements.txt

@@ -44,7 +44,8 @@ PyMySQL~=1.1.1
 pymssql~=2.3.2
 pyramid>=1.7
 redis>=2.6
-remoulade>=0.50
+remoulade[limits]>=5.0.0 ; python_version >= "3.12"
+remoulade>=0.50.0 ; python_version < "3.12"
 sqlalchemy>=1.0
 starlette~=0.50
 tornado>=5.1.1

instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py

@@ -252,14 +252,21 @@ def _parse_duration_attrs(
 
 
 def get_default_span_name(request: web.Request) -> str:
-    """Default implementation for get_default_span_details
+    """Returns the span name.
     Args:
         request: the request object itself.
     Returns:
-        The span name.
+        The span name as "{method} {canonical_name}" of a resource if possible or just "{method}".
     """
-    span_name = request.path.strip() or f"HTTP {request.method}"
-    return span_name
+    try:
+        resource = request.match_info.route.resource
+        path = resource.canonical
+    except AttributeError:
+        path = ""
+
+    if path:
+        return f"{request.method} {path}"
+    return f"{request.method}"
 
 
 def _get_view_func(request: web.Request) -> str:

instrumentation/opentelemetry-instrumentation-aiohttp-server/tests/test_aiohttp_server_integration.py

@@ -143,7 +143,15 @@ async def fixture_server_fixture(tracer, aiohttp_server, suppress):
     AioHttpServerInstrumentor().instrument(tracer_provider=tracer_provider)
 
     app = aiohttp.web.Application()
-    app.add_routes([aiohttp.web.get("/test-path", default_handler)])
+    app.add_routes(
+        [
+            aiohttp.web.get("/test-path", default_handler),
+            aiohttp.web.get("/test-path/{url_param}", default_handler),
+            aiohttp.web.get(
+                "/object/{object_id}/action/{another_param}", default_handler
+            ),
+        ]
+    )
     if suppress:
         with suppress_http_instrumentation():
             server = await aiohttp_server(app)
@@ -198,6 +206,60 @@ async def test_status_code_instrumentation(
     assert url == span.attributes[HTTP_TARGET]
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "span_name, example_paths",
+    [
+        (
+            "GET /test-path/{url_param}",
+            (
+                "/test-path/foo",
+                "/test-path/bar",
+            ),
+        ),
+        (
+            "GET /object/{object_id}/action/{another_param}",
+            (
+                "/object/1/action/bar",
+                "/object/234/action/baz",
+            ),
+        ),
+        (
+            "GET",
+            (
+                "/i/dont/exist",
+                "/me-neither",
+            ),
+        ),
+    ],
+)
+async def test_url_params_instrumentation(
+    tracer,
+    server_fixture,
+    aiohttp_client,
+    span_name,
+    example_paths,
+):
+    _, memory_exporter = tracer
+    server, _ = server_fixture
+
+    assert len(memory_exporter.get_finished_spans()) == 0
+
+    client = await aiohttp_client(server)
+    for path in example_paths:
+        await client.get(path)
+
+    assert len(memory_exporter.get_finished_spans()) == 2
+
+    for request_path, span in zip(
+        example_paths, memory_exporter.get_finished_spans()
+    ):
+        assert span_name == span.name
+        assert request_path == span.attributes[HTTP_TARGET]
+        full_url = f"http://{server.host}:{server.port}{request_path}"
+        assert full_url == span.attributes[HTTP_URL]
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize("suppress", [True])
 async def test_suppress_instrumentation(

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

@@ -301,10 +301,6 @@ def response_hook(span: Span, status: str, response_headers: List):
 )
 
 _logger = getLogger(__name__)
-# Global constants for Flask 3.1+ streaming context cleanup
-_IS_FLASK_31_PLUS = hasattr(flask, "__version__") and package_version.parse(
-    flask.__version__
-) >= package_version.parse("3.1.0")
 
 _ENVIRON_STARTTIME_KEY = "opentelemetry-flask.starttime_key"
 _ENVIRON_SPAN_KEY = "opentelemetry-flask.span_key"
@@ -316,6 +312,11 @@ def response_hook(span: Span, status: str, response_headers: List):
 
 flask_version = version("flask")
 
+# Global constant for Flask 3.1+ streaming context cleanup
+_IS_FLASK_31_PLUS = package_version.parse(
+    flask_version
+) >= package_version.parse("3.1.0")
+
 if package_version.parse(flask_version) >= package_version.parse("2.2.0"):
 
     def _request_ctx_ref() -> weakref.ReferenceType:

instrumentation/opentelemetry-instrumentation-flask/tests/test_flask_compatibility.py

@@ -20,6 +20,7 @@
 import io
 import threading
 import time
+from importlib.metadata import version
 from unittest import mock, skipIf
 
 import flask
@@ -37,7 +38,7 @@
 class TestFlaskCompatibility(WsgiTestBase):
     def setUp(self):
         super().setUp()
-        self.flask_version = flask.__version__
+        self.flask_version = version("flask")
 
     def test_streaming_response_context_cleanup(self):
         """Test that streaming responses properly clean up context"""

tests/opentelemetry-docker-tests/tests/test-requirements.txt

@@ -58,7 +58,7 @@ python-dotenv==0.21.1
 pytz==2024.1
 PyYAML==5.3.1
 redis==5.0.1
-requests==2.25.0
+requests==2.31.0
 six==1.16.0
 SQLAlchemy==1.4.52
 texttable==1.7.0