Merge branch 'main' into lambda-span-link

.github/component_owners.yml

@@ -46,3 +46,6 @@ components:
 
   instrumentation/opentelemetry-instrumentation-urllib3:
     - shalevr
+
+  instrumentation/opentelemetry-instrumentation-sqlalchemy:
+    - shalevr

.github/workflows/release.yml

@@ -125,7 +125,7 @@ jobs:
                             --title "Version ${STABLE_VERSION}/${UNSTABLE_VERSION}" \
                             --notes-file /tmp/release-notes.txt \
                             --discussion-category announcements \
-                            v$STABLE_VERSION
+                            v$UNSTABLE_VERSION
 
       - uses: actions/checkout@v3
         with:

.github/workflows/test.yml

@@ -6,7 +6,7 @@ on:
     - 'release/*'
   pull_request:
 env:
-  CORE_REPO_SHA: d0bb12b34b0c487198c935001636b6163485a50f
+  CORE_REPO_SHA: 2d1f0b9f5fce62549d1338882f37b91b95881c75
 
 jobs:
   build:

CHANGELOG.md

@@ -7,15 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Add metrics instrumentation for sqlalchemy
+  ([#1645](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1645))
+
+- Fix exception in Urllib3 when dealing with filelike body.
+  ([#1399](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1399))
+
+- Fix httpx resource warnings
+  ([#1695](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1695))
+
 ### Added
 
 - Add connection attributes to sqlalchemy connect span
   ([#1608](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1608))
+- Add support for enabling Redis sanitization from environment variable
+  ([#1690](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1690))
 
 ### Fixed
 
 - Fix Flask instrumentation to only close the span if it was created by the same thread.
   ([#1654](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1654))
+- `opentelemetry-instrumentation-system-metrics` Fix initialization of the instrumentation class when configuration is provided
+  ([#1438](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1439))
 
 ## Version 1.16.0/0.37b0 (2023-02-17)
 

RELEASING.md

@@ -2,7 +2,7 @@
 
 ## Preparing a new major or minor release
 
-* Run the [Prepare release branch workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/prepare-release-branch.yml).
+* Run the [Prepare release branch workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/prepare-release-branch.yml).
   * Press the "Run workflow" button, and leave the default branch `main` selected.
     * If making a pre-release of stable components (e.g. release candidate),
       enter the pre-release version number, e.g. `1.9.0rc2`.
@@ -13,21 +13,21 @@
 ## Preparing a new patch release
 
 * Backport pull request(s) to the release branch.
-  * Run the [Backport workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/backport.yml).
+  * Run the [Backport workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/backport.yml).
   * Press the "Run workflow" button, then select the release branch from the dropdown list,
     e.g. `release/v1.9.x`, then enter the pull request number that you want to backport,
     then click the "Run workflow" button below that.
   * Review and merge the backport pull request that it generates.
 * Merge a pull request to the release branch updating the `CHANGELOG.md`.
   * The heading for the unreleased entries should be `## Unreleased`.
-* Run the [Prepare patch release workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/prepare-patch-release.yml).
+* Run the [Prepare patch release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/prepare-patch-release.yml).
   * Press the "Run workflow" button, then select the release branch from the dropdown list,
     e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
   * Review and merge the pull request that it creates for updating the version.
 
 ## Making the release
 
-* Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/release.yml).
+* Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml).
   * Press the "Run workflow" button, then select the release branch from the dropdown list,
     e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
   * This workflow will publish the artifacts and publish a GitHub release with release notes based on the change log.
@@ -69,9 +69,9 @@
 ## After the release
 
 * Check PyPI
-  * This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python/blob/main/.github/workflows/publish.yml).
-  * Check the [action logs](https://github.com/open-telemetry/opentelemetry-python/actions?query=workflow%3APublish) to make sure packages have been uploaded to PyPI
-  * Check the release history (e.g. https://pypi.org/project/opentelemetry-api/#history) on PyPI
+  * This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/release.yml).
+  * Check the [action logs](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml) to make sure packages have been uploaded to PyPI
+  * Check the release history (e.g. https://pypi.org/project/opentelemetry-instrumentation/#history) on PyPI
   * If for some reason the action failed, see [Publish failed](#publish-failed) below
 * Move stable tag
   * Run the following (TODO automate):

exporter/opentelemetry-exporter-prometheus-remote-write/example/Dockerfile

@@ -6,6 +6,6 @@ WORKDIR /code
 COPY . .
 
 RUN pip install -e .
-RUN pip install -r ./examples/requirements.txt
+RUN pip install -r ./example/requirements.txt
 
-CMD ["python", "./examples/sampleapp.py"]
+CMD ["python", "./example/sampleapp.py"]

exporter/opentelemetry-exporter-prometheus-remote-write/example/README.md

@@ -14,7 +14,7 @@ data
 *Users do not need to install Python as the app will be run in the Docker Container*
 
 ## Instructions
-1. Run `docker-compose up -d` in the the `examples/` directory
+1. Run `docker-compose up -d` in the the `example/` directory
 
 The `-d` flag causes all services to run in detached mode and frees up your
 terminal session. This also causes no logs to show up. Users can attach themselves to the service's logs manually using `docker logs ${CONTAINER_ID} --follow`
@@ -39,4 +39,4 @@ terminal session. This also causes no logs to show up. Users can attach themselv
    * Click the refresh button and data should show up on the graph
 
 6. Shutdown the services when finished
-   * Run `docker-compose down` in the examples directory
+   * Run `docker-compose down` in the example directory

exporter/opentelemetry-exporter-prometheus-remote-write/example/docker-compose.yml

@@ -30,4 +30,4 @@ services:
   sample_app:
     build:
       context: ../
-      dockerfile: ./examples/Dockerfile
+      dockerfile: ./example/Dockerfile

instrumentation/README.md

@@ -16,7 +16,7 @@
 | [opentelemetry-instrumentation-django](./opentelemetry-instrumentation-django) | django >= 1.10 | Yes
 | [opentelemetry-instrumentation-elasticsearch](./opentelemetry-instrumentation-elasticsearch) | elasticsearch >= 2.0 | No
 | [opentelemetry-instrumentation-falcon](./opentelemetry-instrumentation-falcon) | falcon >= 1.4.1, < 4.0.0 | Yes
-| [opentelemetry-instrumentation-fastapi](./opentelemetry-instrumentation-fastapi) | fastapi <= 0.90.1 | Yes
+| [opentelemetry-instrumentation-fastapi](./opentelemetry-instrumentation-fastapi) | fastapi ~= 0.58 | Yes
 | [opentelemetry-instrumentation-flask](./opentelemetry-instrumentation-flask) | flask >= 1.0, < 3.0 | Yes
 | [opentelemetry-instrumentation-grpc](./opentelemetry-instrumentation-grpc) | grpcio ~= 1.27 | No
 | [opentelemetry-instrumentation-httpx](./opentelemetry-instrumentation-httpx) | httpx >= 0.18.0 | No
@@ -34,7 +34,7 @@
 | [opentelemetry-instrumentation-remoulade](./opentelemetry-instrumentation-remoulade) | remoulade >= 0.50 | No
 | [opentelemetry-instrumentation-requests](./opentelemetry-instrumentation-requests) | requests ~= 2.0 | Yes
 | [opentelemetry-instrumentation-sklearn](./opentelemetry-instrumentation-sklearn) | scikit-learn ~= 0.24.0 | No
-| [opentelemetry-instrumentation-sqlalchemy](./opentelemetry-instrumentation-sqlalchemy) | sqlalchemy | No
+| [opentelemetry-instrumentation-sqlalchemy](./opentelemetry-instrumentation-sqlalchemy) | sqlalchemy | Yes
 | [opentelemetry-instrumentation-sqlite3](./opentelemetry-instrumentation-sqlite3) | sqlite3 | No
 | [opentelemetry-instrumentation-starlette](./opentelemetry-instrumentation-starlette) | starlette ~= 0.13.0 | Yes
 | [opentelemetry-instrumentation-system-metrics](./opentelemetry-instrumentation-system-metrics) | psutil >= 5 | No

instrumentation/opentelemetry-instrumentation-aws-lambda/src/opentelemetry/instrumentation/aws_lambda/__init__.py

@@ -24,11 +24,11 @@
     # Copy this snippet into an AWS Lambda function
 
     import boto3
-    from opentelemetry.instrumentation.botocore import AwsBotocoreInstrumentor
+    from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
     from opentelemetry.instrumentation.aws_lambda import AwsLambdaInstrumentor
 
     # Enable instrumentation
-    AwsBotocoreInstrumentor().instrument()
+    BotocoreInstrumentor().instrument()
     AwsLambdaInstrumentor().instrument()
 
     # Lambda function

instrumentation/opentelemetry-instrumentation-fastapi/pyproject.toml

@@ -34,7 +34,7 @@ dependencies = [
 
 [project.optional-dependencies]
 instruments = [
-  "fastapi <= 0.90.1",
+  "fastapi ~= 0.58",
 ]
 test = [
   "opentelemetry-instrumentation-fastapi[instruments]",

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

@@ -179,7 +179,7 @@ def client_response_hook(span: Span, message: dict):
 from starlette.routing import Match
 
 from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
-from opentelemetry.instrumentation.asgi.package import _instruments
+from opentelemetry.instrumentation.fastapi.package import _instruments
 from opentelemetry.instrumentation.fastapi.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.metrics import get_meter

instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/package.py

@@ -13,6 +13,6 @@
 # limitations under the License.
 
 
-_instruments = ("fastapi <= 0.90.1",)
+_instruments = ("fastapi ~= 0.58",)
 
 _supports_metrics = True

instrumentation/opentelemetry-instrumentation-fastapi/tests/test_fastapi_instrumentation.py

@@ -17,6 +17,7 @@
 from unittest.mock import patch
 
 import fastapi
+from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
 from fastapi.responses import JSONResponse
 from fastapi.testclient import TestClient
 
@@ -87,6 +88,7 @@ def setUp(self):
         self.exclude_patch.start()
         self._instrumentor = otel_fastapi.FastAPIInstrumentor()
         self._app = self._create_app()
+        self._app.add_middleware(HTTPSRedirectMiddleware)
         self._client = TestClient(self._app)
 
     def tearDown(self):
@@ -110,12 +112,8 @@ def test_uninstrument_app(self):
         self._client.get("/foobar")
         spans = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(spans), 3)
-        # pylint: disable=import-outside-toplevel
-        from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
 
-        self._app.add_middleware(HTTPSRedirectMiddleware)
         self._instrumentor.uninstrument_app(self._app)
-        print(self._app.user_middleware[0].cls)
         self.assertFalse(
             isinstance(
                 self._app.user_middleware[0].cls, OpenTelemetryMiddleware
@@ -212,18 +210,18 @@ def test_basic_metric_success(self):
         duration = max(round((default_timer() - start) * 1000), 0)
         expected_duration_attributes = {
             "http.method": "GET",
-            "http.host": "testserver",
-            "http.scheme": "http",
+            "http.host": "testserver:443",
+            "http.scheme": "https",
             "http.flavor": "1.1",
             "http.server_name": "testserver",
-            "net.host.port": 80,
+            "net.host.port": 443,
             "http.status_code": 200,
             "http.target": "/foobar",
         }
         expected_requests_count_attributes = {
             "http.method": "GET",
-            "http.host": "testserver",
-            "http.scheme": "http",
+            "http.host": "testserver:443",
+            "http.scheme": "https",
             "http.flavor": "1.1",
             "http.server_name": "testserver",
         }

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

@@ -162,6 +162,7 @@ def response_hook(span, request, response):
 """
 import logging
 import typing
+from types import TracebackType
 
 import httpx
 
@@ -293,6 +294,18 @@ def __init__(
         self._request_hook = request_hook
         self._response_hook = response_hook
 
+    def __enter__(self) -> "SyncOpenTelemetryTransport":
+        self._transport.__enter__()
+        return self
+
+    def __exit__(
+        self,
+        exc_type: typing.Optional[typing.Type[BaseException]] = None,
+        exc_value: typing.Optional[BaseException] = None,
+        traceback: typing.Optional[TracebackType] = None,
+    ) -> None:
+        self._transport.__exit__(exc_type, exc_value, traceback)
+
     def handle_request(
         self,
         *args,
@@ -343,6 +356,9 @@ def handle_request(
 
         return response
 
+    def close(self) -> None:
+        self._transport.close()
+
 
 class AsyncOpenTelemetryTransport(httpx.AsyncBaseTransport):
     """Async transport class that will trace all requests made with a client.
@@ -372,6 +388,18 @@ def __init__(
         self._request_hook = request_hook
         self._response_hook = response_hook
 
+    async def __aenter__(self) -> "AsyncOpenTelemetryTransport":
+        await self._transport.__aenter__()
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: typing.Optional[typing.Type[BaseException]] = None,
+        exc_value: typing.Optional[BaseException] = None,
+        traceback: typing.Optional[TracebackType] = None,
+    ) -> None:
+        await self._transport.__aexit__(exc_type, exc_value, traceback)
+
     async def handle_async_request(
         self, *args, **kwargs
     ) -> typing.Union[
@@ -423,6 +451,9 @@ async def handle_async_request(
 
         return response
 
+    async def aclose(self) -> None:
+        await self._transport.aclose()
+
 
 class _InstrumentedClient(httpx.Client):
     _tracer_provider = None

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

@@ -88,17 +88,37 @@ def response_hook(span, instance, response):
     client = redis.StrictRedis(host="localhost", port=6379)
     client.get("my-key")
 
+Configuration
+-------------
+
+Query sanitization
+******************
+To enable query sanitization with an environment variable, set
+``OTEL_PYTHON_INSTRUMENTATION_SANITIZE_REDIS`` to "true".
+
+For example,
+
+::
+
+    export OTEL_PYTHON_INSTRUMENTATION_SANITIZE_REDIS="true"
+
+will result in traced queries like "SET ? ?".
+
 API
 ---
 """
 import typing
+from os import environ
 from typing import Any, Collection
 
 import redis
 from wrapt import wrap_function_wrapper
 
 from opentelemetry import trace
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.instrumentation.redis.environment_variables import (
+    OTEL_PYTHON_INSTRUMENTATION_SANITIZE_REDIS,
+)
 from opentelemetry.instrumentation.redis.package import _instruments
 from opentelemetry.instrumentation.redis.util import (
     _extract_conn_attributes,
@@ -287,7 +307,15 @@ def _instrument(self, **kwargs):
             tracer,
             request_hook=kwargs.get("request_hook"),
             response_hook=kwargs.get("response_hook"),
-            sanitize_query=kwargs.get("sanitize_query", False),
+            sanitize_query=kwargs.get(
+                "sanitize_query",
+                environ.get(
+                    OTEL_PYTHON_INSTRUMENTATION_SANITIZE_REDIS, "false"
+                )
+                .lower()
+                .strip()
+                == "true",
+            ),
         )
 
     def _uninstrument(self, **kwargs):

instrumentation/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/environment_variables.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.
+
+OTEL_PYTHON_INSTRUMENTATION_SANITIZE_REDIS = (
+    "OTEL_PYTHON_INSTRUMENTATION_SANITIZE_REDIS"
+)