Update to include excluded paths

Author: ocelotl

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py

@@ -33,7 +33,7 @@
 # It must be done before instrumenting any library
 trace.set_tracer_provider(TracerProvider())
 
-opentelemetry.ext.http_requests.RequestsInstrumentor().instrument()
+opentelemetry.ext.requests.RequestsInstrumentor().instrument()
 
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())

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

@@ -78,18 +78,21 @@ def _wrapped_app(environ, start_response):
         environ[_ENVIRON_STARTTIME_KEY] = time_ns()
 
         def _start_response(status, response_headers, *args, **kwargs):
-            span = flask.request.environ.get(_ENVIRON_SPAN_KEY)
-
-            if span:
-                otel_wsgi.add_response_attributes(
-                    span, status, response_headers
-                )
-            else:
-                _logger.warning(
-                    "Flask environ's OpenTelemetry span "
-                    "missing at _start_response(%s)",
-                    status,
-                )
+
+            if not _disable_trace(flask.request.url):
+
+                span = flask.request.environ.get(_ENVIRON_SPAN_KEY)
+
+                if span:
+                    otel_wsgi.add_response_attributes(
+                        span, status, response_headers
+                    )
+                else:
+                    _logger.warning(
+                        "Flask environ's OpenTelemetry span "
+                        "missing at _start_response(%s)",
+                        status,
+                    )
 
             return start_response(status, response_headers, *args, **kwargs)
 
@@ -99,6 +102,9 @@ def _start_response(status, response_headers, *args, **kwargs):
 
 
 def _before_request():
+    if _disable_trace(flask.request.url):
+        return
+
     environ = flask.request.environ
     span_name = flask.request.endpoint or otel_wsgi.get_default_span_name(
         environ
@@ -160,6 +166,7 @@ def __init__(self, *args, **kwargs):
 def _disable_trace(url):
     excluded_hosts = configuration.Configuration().FLASK_EXCLUDED_HOSTS
     excluded_paths = configuration.Configuration().FLASK_EXCLUDED_PATHS
+
     if excluded_hosts:
         excluded_hosts = str.split(excluded_hosts, ",")
         if disable_tracing_hostname(url, excluded_hosts):

ext/opentelemetry-ext-flask/tests/base_test.py

@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from unittest.mock import patch
+
 from flask import request
 
-from opentelemetry import trace as trace_api
+from opentelemetry import trace
 
 
 def expected_attributes(override_attributes):
@@ -36,6 +38,7 @@ def expected_attributes(override_attributes):
 
 
 class InstrumentationTest:
+
     # pylint: disable=no-member
     def test_only_strings_in_environ(self):
         """
@@ -65,7 +68,7 @@ def test_simple_uninstrument(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "hello_endpoint")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)
 
     def test_404(self):
@@ -84,7 +87,7 @@ def test_404(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "/bye")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)
 
     def test_internal_error(self):
@@ -102,5 +105,22 @@ def test_internal_error(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "hello_endpoint")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)
+
+    @patch.dict(
+        "os.environ",  # type: ignore
+        {
+            "OPENTELEMETRY_PYTHON_FLASK_EXCLUDED_HOSTS": (
+                "http://localhost/excluded"
+            ),
+            "OPENTELEMETRY_PYTHON_FLASK_EXCLUDED_PATHS": "excluded2",
+        },
+    )
+    def test_excluded_path(self):
+        self.client.get("/hello/123")
+        self.client.get("/excluded")
+        self.client.get("/excluded2")
+        span_list = self.memory_exporter.get_finished_spans()
+        self.assertEqual(len(span_list), 1)
+        self.assertEqual(span_list[0].name, "hello_endpoint")

ext/opentelemetry-ext-flask/tests/test_automatic.py

@@ -18,7 +18,8 @@
 from werkzeug.test import Client
 from werkzeug.wrappers import BaseResponse
 
-from opentelemetry import trace as trace_api
+from opentelemetry import trace
+from opentelemetry.configuration import Configuration
 from opentelemetry.ext.flask import FlaskInstrumentor
 from opentelemetry.test.wsgitestutil import WsgiTestBase
 
@@ -30,6 +31,8 @@ class TestAutomatic(WsgiTestBase, InstrumentationTest):
     def setUp(self):
         super().setUp()
 
+        Configuration._instance = None  # pylint: disable=protected-access
+        Configuration.__slots__ = []  # pylint: disable=protected-access
         FlaskInstrumentor().instrument()
 
         self.app = flask.Flask(__name__)
@@ -39,7 +42,16 @@ def hello_endpoint(helloid):
                 raise ValueError(":-(")
             return "Hello: " + str(helloid)
 
+        def excluded_endpoint():
+            return "excluded"
+
+        def excluded2_endpoint():
+            return "excluded2"
+
         self.app.route("/hello/<int:helloid>")(hello_endpoint)
+        self.app.route("/excluded/<int:helloid>")(hello_endpoint)
+        self.app.route("/excluded")(excluded_endpoint)
+        self.app.route("/excluded2")(excluded2_endpoint)
 
         self.client = Client(self.app, BaseResponse)
 
@@ -58,7 +70,7 @@ def test_uninstrument(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "hello_endpoint")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)
 
         FlaskInstrumentor().uninstrument()
@@ -82,5 +94,5 @@ def hello_endpoint(helloid):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "hello_endpoint")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)

ext/opentelemetry-ext-flask/tests/test_programmatic.py

@@ -18,7 +18,8 @@
 from werkzeug.test import Client
 from werkzeug.wrappers import BaseResponse
 
-from opentelemetry import trace as trace_api
+from opentelemetry import trace
+from opentelemetry.configuration import Configuration
 from opentelemetry.ext.flask import FlaskInstrumentor
 from opentelemetry.test.wsgitestutil import WsgiTestBase
 
@@ -30,6 +31,8 @@ class TestProgrammatic(WsgiTestBase, InstrumentationTest):
     def setUp(self):
         super().setUp()
 
+        Configuration._instance = None  # pylint: disable=protected-access
+        Configuration.__slots__ = []  # pylint: disable=protected-access
         self.app = Flask(__name__)
 
         FlaskInstrumentor().instrument_app(self.app)
@@ -39,7 +42,15 @@ def hello_endpoint(helloid):
                 raise ValueError(":-(")
             return "Hello: " + str(helloid)
 
+        def excluded_endpoint():
+            return "excluded"
+
+        def excluded2_endpoint():
+            return "excluded2"
+
         self.app.route("/hello/<int:helloid>")(hello_endpoint)
+        self.app.route("/excluded")(excluded_endpoint)
+        self.app.route("/excluded2")(excluded2_endpoint)
 
         self.client = Client(self.app, BaseResponse)
 
@@ -58,7 +69,7 @@ def test_uninstrument(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "hello_endpoint")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)
 
         FlaskInstrumentor().uninstrument_app(self.app)
@@ -72,5 +83,5 @@ def test_uninstrument(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
         self.assertEqual(span_list[0].name, "hello_endpoint")
-        self.assertEqual(span_list[0].kind, trace_api.SpanKind.SERVER)
+        self.assertEqual(span_list[0].kind, trace.SpanKind.SERVER)
         self.assertEqual(span_list[0].attributes, expected_attrs)