Remove Configuration from instrumentations (open-telemetry#285)

.github/workflows/test.yml

@@ -6,7 +6,7 @@ on:
     - 'release/*'
   pull_request:
 env:
-  CORE_REPO_SHA: f3ee81243b4266729ba5196a7883ce897549aaba
+  CORE_REPO_SHA: 09b010cfcc85e2aa07326e9204541b80a7dd52f0
 
 jobs:
   build:

.pylintrc

@@ -79,6 +79,7 @@ disable=missing-docstring,
       super-init-not-called, # temp-pylint-upgrade
       invalid-overridden-method, # temp-pylint-upgrade 
       missing-module-docstring, # temp-pylint-upgrade
+      import-error, # needed as a workaround as reported here: https://github.com/open-telemetry/opentelemetry-python-contrib/issues/290
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

CHANGELOG.md

@@ -75,6 +75,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update TraceState to adhere to specs
   ([#276](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/276))
 
+### Removed
+- Remove Configuration
+  ([#285](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/285))
+
 ## [0.16b1](https://github.com/open-telemetry/opentelemetry-python-contrib/releases/tag/v0.16b1) - 2020-11-26
 
 ## [0.16b0](https://github.com/open-telemetry/opentelemetry-python-contrib/releases/tag/v0.16b0) - 2020-11-25

docs/nitpick-exceptions.ini

@@ -4,7 +4,6 @@ class_references=
     opentelemetry.trace.propagation.textmap.TextMapPropagator
     ; - AwsXRayFormat
     opentelemetry.trace.propagation.textmap.DictGetter
-    ; - instrumentation.asgi.CarrierGetter
     ; API
     opentelemetry.trace.propagation.textmap.Getter
     ; - DatadogFormat

eachdist.ini

@@ -7,6 +7,7 @@ ignore=
     opentelemetry-python-core
 
 sortfirst=
+    util/opentelemetry-util-http
     instrumentation/opentelemetry-instrumentation-wsgi
     instrumentation/opentelemetry-instrumentation-dbapi
     instrumentation/opentelemetry-instrumentation-asgi

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

@@ -18,7 +18,6 @@
 timing through OpenTelemetry.
 """
 
-import operator
 import typing
 import urllib
 from functools import wraps

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

@@ -84,8 +84,6 @@ def _instrument(self, **kwargs):
         # For exemple EC2 uses AWSQueryConnection and S3 uses
         # AWSAuthConnection
 
-        # FIXME should the tracer provider be accessed via Configuration
-        # instead?
         # pylint: disable=attribute-defined-outside-init
         self._tracer = get_tracer(
             __name__, __version__, kwargs.get("tracer_provider")

instrumentation/opentelemetry-instrumentation-django/setup.cfg

@@ -40,6 +40,7 @@ package_dir=
 packages=find_namespace:
 install_requires =
     django >= 1.10
+    opentelemetry-util-http == 0.18.dev0
     opentelemetry-instrumentation-wsgi == 0.18.dev0
     opentelemetry-instrumentation == 0.18.dev0
     opentelemetry-api == 0.18.dev0

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

@@ -13,10 +13,13 @@
 # limitations under the License.
 
 from logging import getLogger
+from os import environ
 
 from django.conf import settings
 
-from opentelemetry.configuration import Configuration
+from opentelemetry.instrumentation.django.environment_variables import (
+    OTEL_PYTHON_DJANGO_INSTRUMENT,
+)
 from opentelemetry.instrumentation.django.middleware import _DjangoMiddleware
 from opentelemetry.instrumentation.django.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
@@ -43,11 +46,7 @@ def _instrument(self, **kwargs):
 
         # FIXME this is probably a pattern that will show up in the rest of the
         # ext. Find a better way of implementing this.
-        # FIXME Probably the evaluation of strings into boolean values can be
-        # built inside the Configuration class itself with the magic method
-        # __bool__
-
-        if Configuration().DJANGO_INSTRUMENT is False:
+        if environ.get(OTEL_PYTHON_DJANGO_INSTRUMENT) == "False":
             return
 
         # This can not be solved, but is an inherent problem of this approach:

instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/environment_variables.py

@@ -0,0 +1,15 @@
+# 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_DJANGO_INSTRUMENT = "OTEL_PYTHON_DJANGO_INSTRUMENT"

instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware.py

@@ -12,12 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import time
 from logging import getLogger
+from time import time
 
 from django.conf import settings
 
-from opentelemetry.configuration import Configuration
 from opentelemetry.context import attach, detach
 from opentelemetry.instrumentation.django.version import __version__
 from opentelemetry.instrumentation.utils import extract_attributes_from_object
@@ -28,6 +27,7 @@
 )
 from opentelemetry.propagators import extract
 from opentelemetry.trace import SpanKind, get_tracer
+from opentelemetry.util.http import get_excluded_urls, get_traced_request_attrs
 
 try:
     from django.core.urlresolvers import (  # pylint: disable=no-name-in-module
@@ -61,9 +61,8 @@ class _DjangoMiddleware(MiddlewareMixin):
     _environ_span_key = "opentelemetry-instrumentor-django.span_key"
     _environ_exception_key = "opentelemetry-instrumentor-django.exception_key"
 
-    _excluded_urls = Configuration()._excluded_urls("django")
-
-    _traced_request_attrs = Configuration()._traced_request_attrs("django")
+    _traced_request_attrs = get_traced_request_attrs("DJANGO")
+    _excluded_urls = get_excluded_urls("DJANGO")
 
     @staticmethod
     def _get_span_name(request):
@@ -111,23 +110,23 @@ def process_request(self, request):
             return
 
         # pylint:disable=W0212
-        request._otel_start_time = time.time()
+        request._otel_start_time = time()
 
-        environ = request.META
+        request_meta = request.META
 
-        token = attach(extract(carrier_getter, environ))
+        token = attach(extract(carrier_getter, request_meta))
 
         tracer = get_tracer(__name__, __version__)
 
         span = tracer.start_span(
             self._get_span_name(request),
             kind=SpanKind.SERVER,
-            start_time=environ.get(
+            start_time=request_meta.get(
                 "opentelemetry-instrumentor-django.starttime_key"
             ),
         )
 
-        attributes = collect_request_attributes(environ)
+        attributes = collect_request_attributes(request_meta)
         # pylint:disable=W0212
         request._otel_labels = self._get_metric_labels_from_attributes(
             attributes
@@ -215,7 +214,7 @@ def process_response(self, request, response):
             if metric_recorder is not None:
                 # pylint:disable=W0212
                 metric_recorder.record_server_duration_range(
-                    request._otel_start_time, time.time(), request._otel_labels
+                    request._otel_start_time, time(), request._otel_labels
                 )
         except Exception as ex:  # pylint: disable=W0703
             _logger.warning("Error recording duration metrics: %s", ex)

instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py

@@ -21,13 +21,13 @@
 from django.test import Client
 from django.test.utils import setup_test_environment, teardown_test_environment
 
-from opentelemetry.configuration import Configuration
 from opentelemetry.instrumentation.django import DjangoInstrumentor
 from opentelemetry.sdk.util import get_dict_as_key
 from opentelemetry.test.test_base import TestBase
 from opentelemetry.test.wsgitestutil import WsgiTestBase
 from opentelemetry.trace import SpanKind
 from opentelemetry.trace.status import StatusCode
+from opentelemetry.util.http import get_excluded_urls, get_traced_request_attrs
 
 # pylint: disable=import-error
 from .views import (
@@ -64,7 +64,6 @@ def setUp(self):
         super().setUp()
         setup_test_environment()
         _django_instrumentor.instrument()
-        Configuration._reset()  # pylint: disable=protected-access
         self.env_patch = patch.dict(
             "os.environ",
             {
@@ -75,11 +74,11 @@ def setUp(self):
         self.env_patch.start()
         self.exclude_patch = patch(
             "opentelemetry.instrumentation.django.middleware._DjangoMiddleware._excluded_urls",
-            Configuration()._excluded_urls("django"),
+            get_excluded_urls("DJANGO"),
         )
         self.traced_patch = patch(
             "opentelemetry.instrumentation.django.middleware._DjangoMiddleware._traced_request_attrs",
-            Configuration()._traced_request_attrs("django"),
+            get_traced_request_attrs("DJANGO"),
         )
         self.exclude_patch.start()
         self.traced_patch.start()

instrumentation/opentelemetry-instrumentation-falcon/setup.cfg

@@ -42,6 +42,7 @@ packages=find_namespace:
 install_requires =
     falcon ~= 2.0
     opentelemetry-instrumentation-wsgi == 0.18.dev0
+    opentelemetry-util-http == 0.18.dev0
     opentelemetry-instrumentation == 0.18.dev0
     opentelemetry-api == 0.18.dev0
 

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

@@ -43,14 +43,13 @@ def on_get(self, req, resp):
 ---
 """
 
-import sys
 from logging import getLogger
+from sys import exc_info
 
 import falcon
 
 import opentelemetry.instrumentation.wsgi as otel_wsgi
-from opentelemetry import configuration, context, propagators, trace
-from opentelemetry.configuration import Configuration
+from opentelemetry import context, propagators, trace
 from opentelemetry.instrumentation.falcon.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.instrumentation.utils import (
@@ -59,6 +58,7 @@ def on_get(self, req, resp):
 )
 from opentelemetry.trace.status import Status
 from opentelemetry.util import time_ns
+from opentelemetry.util.http import get_excluded_urls, get_traced_request_attrs
 
 _logger = getLogger(__name__)
 
@@ -68,8 +68,9 @@ def on_get(self, req, resp):
 _ENVIRON_TOKEN = "opentelemetry-falcon.token"
 _ENVIRON_EXC = "opentelemetry-falcon.exc"
 
-cfg = configuration.Configuration()
-_excluded_urls = cfg._excluded_urls("falcon")
+
+_excluded_urls = get_excluded_urls("FALCON")
+_traced_request_attrs = get_traced_request_attrs("FALCON")
 
 
 class FalconInstrumentor(BaseInstrumentor):
@@ -149,7 +150,7 @@ class _TraceMiddleware:
 
     def __init__(self, tracer=None, traced_request_attrs=None):
         self.tracer = tracer
-        self._traced_request_attrs = cfg._traced_request_attrs("falcon")
+        self._traced_request_attrs = _traced_request_attrs
 
     def process_request(self, req, resp):
         span = req.env.get(_ENVIRON_SPAN_KEY)
@@ -186,7 +187,7 @@ def process_response(
             status = "404"
             reason = "NotFound"
 
-        exc_type, exc, _ = sys.exc_info()
+        exc_type, exc, _ = exc_info()
         if exc_type and not req_succeeded:
             if "HTTPNotFound" in exc_type.__name__:
                 status = "404"

instrumentation/opentelemetry-instrumentation-falcon/tests/test_falcon.py

@@ -16,10 +16,10 @@
 
 from falcon import testing
 
-from opentelemetry.configuration import Configuration
 from opentelemetry.instrumentation.falcon import FalconInstrumentor
 from opentelemetry.test.test_base import TestBase
 from opentelemetry.trace.status import StatusCode
+from opentelemetry.util.http import get_excluded_urls, get_traced_request_attrs
 
 from .app import make_app
 
@@ -30,7 +30,6 @@ def setUp(self):
         FalconInstrumentor().instrument()
         self.app = make_app()
         # pylint: disable=protected-access
-        Configuration()._reset()
         self.env_patch = patch.dict(
             "os.environ",
             {
@@ -41,15 +40,15 @@ def setUp(self):
         self.env_patch.start()
         self.exclude_patch = patch(
             "opentelemetry.instrumentation.falcon._excluded_urls",
-            Configuration()._excluded_urls("falcon"),
+            get_excluded_urls("FALCON"),
         )
         middleware = self.app._middleware[0][  # pylint:disable=W0212
             0
         ].__self__
         self.traced_patch = patch.object(
             middleware,
             "_traced_request_attrs",
-            Configuration()._traced_request_attrs("falcon"),
+            get_traced_request_attrs("FALCON"),
         )
         self.exclude_patch.start()
         self.traced_patch.start()

instrumentation/opentelemetry-instrumentation-fastapi/setup.cfg

@@ -40,6 +40,7 @@ packages=find_namespace:
 install_requires =
     opentelemetry-api == 0.18.dev0
     opentelemetry-instrumentation-asgi == 0.18.dev0
+    opentelemetry-util-http == 0.18.dev0
 
 [options.entry_points]
 opentelemetry_instrumentor =

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

@@ -11,17 +11,15 @@
 # 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.
-from typing import Optional
 
 import fastapi
 from starlette.routing import Match
 
-from opentelemetry.configuration import Configuration
 from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
-from opentelemetry.instrumentation.fastapi.version import __version__  # noqa
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.util.http import get_excluded_urls
 
-_excluded_urls = Configuration()._excluded_urls("fastapi")
+_excluded_urls = get_excluded_urls("FASTAPI")
 
 
 class FastAPIInstrumentor(BaseInstrumentor):

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

@@ -19,8 +19,8 @@
 from fastapi.testclient import TestClient
 
 import opentelemetry.instrumentation.fastapi as otel_fastapi
-from opentelemetry.configuration import Configuration
 from opentelemetry.test.test_base import TestBase
+from opentelemetry.util.http import get_excluded_urls
 
 
 class TestFastAPIManualInstrumentation(TestBase):
@@ -31,15 +31,14 @@ def _create_app(self):
 
     def setUp(self):
         super().setUp()
-        Configuration()._reset()
         self.env_patch = patch.dict(
             "os.environ",
             {"OTEL_PYTHON_FASTAPI_EXCLUDED_URLS": "/exclude/123,healthzz"},
         )
         self.env_patch.start()
         self.exclude_patch = patch(
             "opentelemetry.instrumentation.fastapi._excluded_urls",
-            Configuration()._excluded_urls("fastapi"),
+            get_excluded_urls("FASTAPI"),
         )
         self.exclude_patch.start()
         self._instrumentor = otel_fastapi.FastAPIInstrumentor()

instrumentation/opentelemetry-instrumentation-flask/setup.cfg

@@ -40,8 +40,9 @@ package_dir=
 packages=find_namespace:
 install_requires =
     flask ~= 1.0
-    opentelemetry-instrumentation-wsgi == 0.18.dev0
+    opentelemetry-util-http == 0.18.dev0
     opentelemetry-instrumentation == 0.18.dev0
+    opentelemetry-instrumentation-wsgi == 0.18.dev0
     opentelemetry-api == 0.18.dev0
 
 [options.extras_require]