Add convenience methods to access common config options in Configuration class

.github/workflows/test.yml

@@ -10,7 +10,7 @@ env:
   # Otherwise, set variable to the commit of your branch on
   # opentelemetry-python-contrib which is compatible with these Core repo
   # changes.
-  CONTRIB_REPO_SHA: bcec49cf2eccf8da66c9e63b9836ea8a20516efc
+  CONTRIB_REPO_SHA: 61ae201677be80e333746f06bc9485fa8856f42c
 
 jobs:
   build:

opentelemetry-api/src/opentelemetry/configuration/__init__.py

@@ -93,14 +93,26 @@
 to override this value instead of changing it.
 """
 
+import re
 from os import environ
-from re import fullmatch
-from typing import ClassVar, Dict, Optional, TypeVar, Union
+from typing import ClassVar, Dict, List, Optional, Sequence, TypeVar, Union
 
 ConfigValue = Union[str, bool, int, float]
 _T = TypeVar("_T", ConfigValue, Optional[ConfigValue])
 
 
+class ExcludeList:
+    """Class to exclude certain paths (given as a list of regexes) from tracing requests"""
+
+    def __init__(self, excluded_urls: Sequence[str]):
+        self._non_empty = len(excluded_urls) > 0
+        if self._non_empty:
+            self._regex = re.compile("|".join(excluded_urls))
+
+    def url_disabled(self, url: str) -> bool:
+        return bool(self._non_empty and re.search(self._regex, url))
+
+
 class Configuration:
     _instance = None  # type: ClassVar[Optional[Configuration]]
     _config_map = {}  # type: ClassVar[Dict[str, ConfigValue]]
@@ -113,7 +125,7 @@ def __new__(cls) -> "Configuration":
             instance = super().__new__(cls)
             for key, value_str in environ.items():
 
-                match = fullmatch(r"OTEL_(PYTHON_)?([A-Za-z_][\w_]*)", key)
+                match = re.fullmatch(r"OTEL_(PYTHON_)?([A-Za-z_][\w_]*)", key)
 
                 if match is not None:
 
@@ -167,3 +179,20 @@ def _reset(cls) -> None:
         if cls._instance:
             cls._instance._config_map.clear()  # pylint: disable=protected-access
             cls._instance = None
+
+    def traced_request_attrs(self, instrumentation: str) -> List[str]:
+        """Returns list of traced request attributes for instrumentation."""
+        key = "{}_TRACED_REQUEST_ATTRS".format(instrumentation.upper())
+        value = self._config_map.get(key, "")
+
+        request_attrs = (
+            [attr.strip() for attr in str.split(value, ",")] if value else []  # type: ignore
+        )
+        return request_attrs
+
+    def excluded_urls(self, instrumentation: str) -> ExcludeList:
+        key = "{}_EXCLUDED_URLS".format(instrumentation.upper())
+        value = self._config_map.get(key, "")
+
+        urls = str.split(value, ",") if value else []  # type: ignore
+        return ExcludeList(urls)

opentelemetry-api/src/opentelemetry/util/__init__.py

@@ -65,15 +65,3 @@ def _load_meter_provider(provider: str) -> "MeterProvider":
 
 def _load_trace_provider(provider: str) -> "TracerProvider":
     return cast("TracerProvider", _load_provider(provider))
-
-
-class ExcludeList:
-    """Class to exclude certain paths (given as a list of regexes) from tracing requests"""
-
-    def __init__(self, excluded_urls: Sequence[str]):
-        self._non_empty = len(excluded_urls) > 0
-        if self._non_empty:
-            self._regex = re.compile("|".join(excluded_urls))
-
-    def url_disabled(self, url: str) -> bool:
-        return bool(self._non_empty and re.search(self._regex, url))

opentelemetry-api/tests/configuration/test_configuration.py

@@ -145,3 +145,32 @@ def test_float(self) -> None:
         self.assertEqual(
             Configuration().NON_FLOAT, "-12z3.123"
         )  # pylint: disable=no-member
+
+    @patch.dict(
+        "os.environ",  # type: ignore
+        {
+            "OTEL_PYTHON_WEBFRAMEWORK_TRACED_REQUEST_ATTRS": "content_type,keep_alive",
+        },
+    )
+    def test_traced_request_attrs(self) -> None:
+        cfg = Configuration()
+        request_attrs = cfg.traced_request_attrs("webframework")
+        self.assertEqual(len(request_attrs), 2)
+        self.assertIn("content_type", request_attrs)
+        self.assertIn("keep_alive", request_attrs)
+        self.assertNotIn("authorization", request_attrs)
+
+    @patch.dict(
+        "os.environ",  # type: ignore
+        {
+            "OTEL_PYTHON_WEBFRAMEWORK_EXCLUDED_URLS": "/healthzz,path,/issues/.*/view",
+        },
+    )
+    def test_excluded_urls(self) -> None:
+        cfg = Configuration()
+        excluded_urls = cfg.excluded_urls("webframework")
+        self.assertTrue(excluded_urls.url_disabled("/healthzz"))
+        self.assertTrue(excluded_urls.url_disabled("/path"))
+        self.assertTrue(excluded_urls.url_disabled("/issues/123/view"))
+        self.assertFalse(excluded_urls.url_disabled("/issues"))
+        self.assertFalse(excluded_urls.url_disabled("/hello"))

opentelemetry-api/tests/util/test_exclude_list.py → opentelemetry-api/tests/configuration/test_exclude_list.py

@@ -13,9 +13,8 @@
 # limitations under the License.
 
 import unittest
-from unittest import mock
 
-from opentelemetry.util import ExcludeList
+from opentelemetry.configuration import ExcludeList
 
 
 class TestExcludeList(unittest.TestCase):