Fix starlette to not instrument when enabled=False (#1000)

* Fix starlette to not instrument when enabled=False

* Add a test

* CHANGELOG and lint

Author: basepi

.pre-commit-config.yaml

@@ -1,15 +1,15 @@
 repos:
 -   repo: https://github.com/pycqa/isort
-    rev: 5.5.4
+    rev: 5.7.0
     hooks:
     -   id: isort
 -   repo: https://github.com/ambv/black
-    rev: stable
+    rev: 20.8b1
     hooks:
     -   id: black
         language_version: python3
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
     hooks:
     -   id: flake8
         exclude: elasticapm\/utils\/wrapt|build|src|tests|dist|conftest.py|setup.py

CHANGELOG.asciidoc

@@ -44,6 +44,7 @@ endif::[]
 * Fix for custom serializers in elasticsearch-py {pull}998[#998]
 * Fix large query truncation in psycopg2 {pull}994[#994]
 * Fix memory metrics reporting when `memory.usage_in_bytes` is unavailable {pull}987[#987]
+* Fix for Starlette/FastAPI integration to properly obey `enabled` config {pull}1000[#1000]
 
 
 [[release-notes-5.x]]

elasticapm/contrib/starlette/__init__.py

@@ -115,7 +115,7 @@ def __init__(self, app: ASGIApp, client: Client):
         """
         self.client = client
 
-        if self.client.config.instrument:
+        if self.client.config.instrument and self.client.config.enabled:
             elasticapm.instrumentation.control.instrument()
 
         super().__init__(app)

tests/contrib/asyncio/starlette_tests.py

@@ -32,14 +32,19 @@
 
 starlette = pytest.importorskip("starlette")  # isort:skip
 
+import types
+
 import mock
+import urllib3
 from starlette.applications import Starlette
 from starlette.responses import PlainTextResponse
 from starlette.testclient import TestClient
 
+import elasticapm
 from elasticapm import async_capture_span
 from elasticapm.conf import constants
 from elasticapm.contrib.starlette import ElasticAPM
+from elasticapm.utils import wrapt
 from elasticapm.utils.disttracing import TraceParent
 
 pytestmark = [pytest.mark.starlette]
@@ -82,7 +87,9 @@ async def without_slash(request):
 
     app.add_middleware(ElasticAPM, client=elasticapm_client)
 
-    return app
+    yield app
+
+    elasticapm.uninstrument()
 
 
 def test_get(app, elasticapm_client):
@@ -271,3 +278,16 @@ def test_trailing_slash_redirect_detection(app, elasticapm_client, url, expected
     assert len(elasticapm_client.events[constants.TRANSACTION]) == 1
     for transaction in elasticapm_client.events[constants.TRANSACTION]:
         assert transaction["name"] == expected
+
+
+@pytest.mark.parametrize(
+    "elasticapm_client",
+    [
+        {"enabled": False},
+    ],
+    indirect=True,
+)
+def test_enabled_instrumentation(app, elasticapm_client):
+    client = TestClient(app)
+
+    assert not isinstance(urllib3.connectionpool.HTTPConnectionPool.urlopen, wrapt.BoundFunctionWrapper)