feat: rename DD_REMOTECONFIG_POLL_SECONDS env var (#4885)

## Description
`DD_REMOTECONFIG_POLL_SECONDS` environment variable is deprecated in
favor of `DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS`

## Reviewer Checklist
- [ ] Title is accurate.
- [ ] Description motivates each change.
- [ ] No unnecessary changes were introduced in this PR.
- [ ] Avoid breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [ ] Tests provided or description of manual testing performed is
included in the code or PR.
- [ ] Release note has been added and follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines),
or else `changelog/no-changelog` label added.
- [ ] All relevant GitHub issues are correctly linked.
- [ ] Backports are identified and tagged with Mergifyio.

Co-authored-by: Federico Mon <[email protected]>
Co-authored-by: Munir Abdinur <[email protected]>
Co-authored-by: Juanjo Alvarez Martinez <[email protected]>
Co-authored-by: Tahir H. Butt <[email protected]>

Author: 5 people

ddtrace/internal/remoteconfig/worker.py

@@ -5,6 +5,7 @@
 from ddtrace.internal.logger import get_logger
 from ddtrace.internal.remoteconfig.client import RemoteConfigClient
 from ddtrace.internal.utils.time import StopWatch
+from ddtrace.vendor.debtcollector import deprecate
 
 
 log = get_logger(__name__)
@@ -15,7 +16,18 @@
 
 def get_poll_interval_seconds():
     # type:() -> float
-    return float(os.getenv("DD_REMOTECONFIG_POLL_SECONDS", default=DEFAULT_REMOTECONFIG_POLL_SECONDS))
+    if os.getenv("DD_REMOTECONFIG_POLL_SECONDS"):
+        deprecate(
+            "Using environment variable 'DD_REMOTECONFIG_POLL_SECONDS' is deprecated",
+            message="Please use DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS instead.",
+            removal_version="2.0.0",
+        )
+    return float(
+        os.getenv(
+            "DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS",
+            default=os.getenv("DD_REMOTECONFIG_POLL_SECONDS", default=DEFAULT_REMOTECONFIG_POLL_SECONDS),
+        )
+    )
 
 
 class RemoteConfigWorker(periodic.PeriodicService):

releasenotes/notes/deprecate-env-var-7e85262ddf9bd989.yaml

@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    ``DD_REMOTECONFIG_POLL_SECONDS`` environment variable is deprecated and will be removed in v2.0. Please use ``DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS`` instead.

setup.cfg

@@ -42,7 +42,4 @@ addopts =
   --junitxml=test-results/junit.xml
 # DEV: The default is `test_*\.py` which will miss `test.py` files
 python_files = test*\.py
-filterwarnings =
-    # Show any DeprecationWarnings once
-    once::DeprecationWarning
 asyncio_mode = auto

tests/debugging/test_debugger.py

@@ -668,7 +668,7 @@ def test_debugger_line_probe_on_wrapped_function(stuff):
 def test_probe_status_logging(mock_check_remote_config_enable_in_agent, monkeypatch):
     mock_check_remote_config_enable_in_agent.return_value = True
 
-    monkeypatch.setenv("DD_REMOTECONFIG_POLL_SECONDS", "0.1")
+    monkeypatch.setenv("DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS", "0.1")
     RemoteConfig.disable()
 
     from ddtrace.internal.remoteconfig.client import RemoteConfigClient

tests/internal/test_remoteconfig.py

@@ -5,6 +5,7 @@
 import json
 import re
 from time import sleep
+import warnings
 
 import mock
 import pytest
@@ -14,6 +15,7 @@
 from ddtrace.internal.remoteconfig.client import RemoteConfigClient
 from ddtrace.internal.remoteconfig.constants import ASM_FEATURES_PRODUCT
 from ddtrace.internal.remoteconfig.constants import REMOTE_CONFIG_AGENT_ENDPOINT
+from ddtrace.internal.remoteconfig.worker import get_poll_interval_seconds
 from tests.utils import override_env
 
 
@@ -137,7 +139,7 @@ def _reload_features(self, metadata, features):
 
     callback = Callback()
 
-    with override_env(dict(DD_REMOTECONFIG_POLL_SECONDS="0.1")):
+    with override_env(dict(DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS="0.1")):
         mock_check_remote_config_enable_in_agent.return_value = True
         mock_send_request.return_value = get_mock_encoded_msg(b'{"asm":{"enabled":true}}')
         rc = RemoteConfig()
@@ -147,6 +149,29 @@ def _reload_features(self, metadata, features):
         assert callback.features == {"asm": {"enabled": True}}
 
 
+def test_remote_configuration_check_deprecated_var():
+    with override_env(dict(DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS="0.1")):
+        with warnings.catch_warnings(record=True) as capture:
+            get_poll_interval_seconds()
+            assert len(capture) == 0
+
+
+def test_remote_configuration_check_deprecated_var_message():
+    with override_env(dict(DD_REMOTECONFIG_POLL_SECONDS="0.1")):
+        with warnings.catch_warnings(record=True) as capture:
+            get_poll_interval_seconds()
+            assert len(capture) == 1
+            assert str(capture[0].message).startswith("Using environment")
+
+
+def test_remote_configuration_check_deprecated_override():
+    with override_env(dict(DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS="0.1", DD_REMOTECONFIG_POLL_SECONDS="0.5")):
+        with warnings.catch_warnings(record=True) as capture:
+            assert get_poll_interval_seconds() == 0.1
+            assert len(capture) == 1
+            assert str(capture[0].message).startswith("Using environment")
+
+
 def test_remoteconfig_semver():
     assert re.match(
         r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*["