Falcon 3 support

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.5.0-0.24b0...HEAD)
 
+### Changed
+- Tests for Falcon 3 support
+  ([#644](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/644))
+
 ## [1.5.0-0.24b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.5.0-0.24b0) - 2021-08-26
 
 ### Added

instrumentation/opentelemetry-instrumentation-falcon/README.rst

@@ -9,8 +9,6 @@ OpenTelemetry Falcon Tracing
 This library builds on the OpenTelemetry WSGI middleware to track web requests
 in Falcon applications.
 
-Currently, only Falcon v2 is supported.
-
 Installation
 ------------
 

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

@@ -140,12 +140,25 @@ def instrumentation_dependencies(self) -> Collection[str]:
         return _instruments
 
     def _instrument(self, **kwargs):
-        self._original_falcon_api = falcon.API
-        falcon.API = partial(_InstrumentedFalconAPI, **kwargs)
+        self._original_falcon_api = None
+        if hasattr(falcon, "App"):
+            # Falcon 3
+            falcon.App = partial(
+                _InstrumentedFalconAPI, **kwargs
+            )
+            self._original_falcon_api = falcon.API
+        else:
+            # Falcon 2
+            self._original_falcon_api = falcon.API
+            falcon.API = partial(_InstrumentedFalconAPI, **kwargs)
 
     def _uninstrument(self, **kwargs):
-        falcon.API = self._original_falcon_api
-
+        if hasattr(falcon, "App"):
+            # Falcon 3
+            falcon.App = self._original_falcon_api
+        else:
+            # Falcon 2
+            falcon.API = self._original_falcon_api
 
 class _InstrumentedFalconAPI(falcon.API):
     def __init__(self, *args, **kwargs):

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

@@ -13,4 +13,4 @@
 # limitations under the License.
 
 
-_instruments = ("falcon ~= 2.0",)
+_instruments = ("falcon >= 2.0.0, < 4.0.0",)

tox.ini

@@ -38,8 +38,8 @@ envlist =
     pypy3-test-instrumentation-elasticsearch{2,5,6}
 
     ; opentelemetry-instrumentation-falcon
-    py3{4,5,6,7,8,9}-test-instrumentation-falcon
-    pypy3-test-instrumentation-falcon
+    py3{4,5,6,7,8,9}-test-instrumentation-falcon{2,3}
+    pypy3-test-instrumentation-falcon{2,3}
 
     ; opentelemetry-instrumentation-fastapi
     ; fastapi only supports 3.6 and above.
@@ -174,6 +174,8 @@ deps =
   ; FIXME: Elasticsearch >=7 causes CI workflow tests to hang, see open-telemetry/opentelemetry-python-contrib#620
   ; elasticsearch7: elasticsearch-dsl>=7.0,<8.0
   ; elasticsearch7: elasticsearch>=7.0,<8.0
+  falcon2: falcon >=2.0.0,<=3.0.0
+  falcon2: falcon >=3.0.0,<=4.0.0
   sqlalchemy11: sqlalchemy>=1.1,<1.2
   sqlalchemy14: aiosqlite
   sqlalchemy14: sqlalchemy~=1.4
@@ -192,7 +194,7 @@ changedir =
   test-instrumentation-dbapi: instrumentation/opentelemetry-instrumentation-dbapi/tests
   test-instrumentation-django: instrumentation/opentelemetry-instrumentation-django/tests
   test-instrumentation-elasticsearch{2,5,6}: instrumentation/opentelemetry-instrumentation-elasticsearch/tests
-  test-instrumentation-falcon: instrumentation/opentelemetry-instrumentation-falcon/tests
+  test-instrumentation-falcon{2,3}: instrumentation/opentelemetry-instrumentation-falcon/tests
   test-instrumentation-fastapi: instrumentation/opentelemetry-instrumentation-fastapi/tests
   test-instrumentation-flask: instrumentation/opentelemetry-instrumentation-flask/tests
   test-instrumentation-urllib: instrumentation/opentelemetry-instrumentation-urllib/tests
@@ -236,15 +238,15 @@ commands_pre =
   grpc: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-grpc[test]
 
   falcon,flask,django,pyramid,tornado,starlette,fastapi,aiohttp,asgi,requests,urllib,wsgi: pip install {toxinidir}/util/opentelemetry-util-http[test]
-  wsgi,falcon,flask,django,pyramid: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-wsgi[test]
+  wsgi,falcon{2,3},flask,django,pyramid: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-wsgi[test]
   asgi,starlette,fastapi: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-asgi[test]
 
   asyncpg: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-asyncpg[test]
 
   boto: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-botocore[test]
   boto: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-boto[test]
 
-  falcon: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-falcon[test]
+  falcon{2,3}: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-falcon[test]
 
   flask: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-flask[test]