Skip to content

Commit

Permalink
Only use generic variable when instrumentation-specific is not set
Browse files Browse the repository at this point in the history
  • Loading branch information
adamantike committed Nov 3, 2021
1 parent f0a3bce commit de7ce9d
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,12 @@ def get_traced_request_attrs(instrumentation):


def get_excluded_urls(instrumentation: str) -> ExcludeList:
# Get instrumentation-specific excluded URLs. If not set, retrieve them
# from generic variable.
excluded_urls = environ.get(
_root.format(f"{instrumentation}_EXCLUDED_URLS"), ""
_root.format(f"{instrumentation}_EXCLUDED_URLS"),
environ.get(_root.format("EXCLUDED_URLS"), ""),
)
if not excluded_urls:
excluded_urls = environ.get(_root.format("EXCLUDED_URLS"), "")

return parse_excluded_urls(excluded_urls)

Expand Down
72 changes: 72 additions & 0 deletions util/opentelemetry-util-http/tests/test_http_excluded_urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# 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.

from unittest.mock import patch

from opentelemetry.test.test_base import TestBase
from opentelemetry.util.http import get_excluded_urls


class TestGetExcludedUrls(TestBase):
@patch.dict(
"os.environ",
{
"OTEL_PYTHON_DJANGO_EXCLUDED_URLS": "excluded_arg/123,excluded_noarg"
},
)
def test_config_from_instrumentation_env(self):
exclude_list = get_excluded_urls("DJANGO")

self.assertTrue(exclude_list.url_disabled("/excluded_arg/123"))
self.assertTrue(exclude_list.url_disabled("/excluded_noarg"))
self.assertFalse(exclude_list.url_disabled("/excluded_arg/125"))

@patch.dict(
"os.environ",
{"OTEL_PYTHON_EXCLUDED_URLS": "excluded_arg/123,excluded_noarg"},
)
def test_config_from_generic_env(self):
exclude_list = get_excluded_urls("DJANGO")

self.assertTrue(exclude_list.url_disabled("/excluded_arg/123"))
self.assertTrue(exclude_list.url_disabled("/excluded_noarg"))
self.assertFalse(exclude_list.url_disabled("/excluded_arg/125"))

@patch.dict(
"os.environ",
{
"OTEL_PYTHON_DJANGO_EXCLUDED_URLS": "excluded_arg/123,excluded_noarg",
"OTEL_PYTHON_EXCLUDED_URLS": "excluded_arg/125",
},
)
def test_config_from_instrumentation_env_takes_precedence(self):
exclude_list = get_excluded_urls("DJANGO")

self.assertTrue(exclude_list.url_disabled("/excluded_arg/123"))
self.assertTrue(exclude_list.url_disabled("/excluded_noarg"))
self.assertFalse(exclude_list.url_disabled("/excluded_arg/125"))

@patch.dict(
"os.environ",
{
"OTEL_PYTHON_DJANGO_EXCLUDED_URLS": "",
"OTEL_PYTHON_EXCLUDED_URLS": "excluded_arg/125",
},
)
def test_config_from_instrumentation_env_empty(self):
exclude_list = get_excluded_urls("DJANGO")

self.assertFalse(exclude_list.url_disabled("/excluded_arg/123"))
self.assertFalse(exclude_list.url_disabled("/excluded_noarg"))
self.assertFalse(exclude_list.url_disabled("/excluded_arg/125"))

0 comments on commit de7ce9d

Please sign in to comment.