Do not use kinto.plugins.statsd by default (#3504)

* Do not use 'kinto.plugins.statsd' by default

* make format

* Include statsd plugin in tests

* Drop statsd initialization step

* Move test for non initialization

Author: leplatrem

kinto/core/initialization.py

@@ -334,16 +334,6 @@ def on_app_created(event):
         config.add_subscriber(on_app_created, ApplicationCreated)
 
 
-def setup_statsd(config):
-    # It would be pretty rare to find users that have a custom ``kinto.initialization_sequence`` setting.
-    # But just in case, warn that it will be removed in next major.
-    warnings.warn(
-        "``setup_statsd()`` is now deprecated. Use ``kinto.core.initialization.setup_metrics()`` instead.",
-        DeprecationWarning,
-    )
-    setup_metrics(config)
-
-
 def install_middlewares(app, settings):
     "Install a set of middlewares defined in the ini file on the given app."
     # Setup new-relic.
@@ -544,10 +534,6 @@ def on_new_response(event):
 
     config.add_subscriber(on_new_response, NewResponse)
 
-    # While statsd is deprecated, we include its plugin by default for retro-compability.
-    if settings["statsd_url"]:
-        config.include("kinto.plugins.statsd")
-
 
 class EventActionFilter:
     def __init__(self, actions, config):

tests/core/resource/test_events.py

@@ -499,6 +499,7 @@ def get_app_settings(cls, *args, **kwargs):
         if not statsd.statsd_module:
             return settings
 
+        settings["includes"] = "kinto.plugins.statsd"
         settings["statsd_url"] = "udp://localhost:8125"
         this_module = "tests.core.resource.test_events"
         settings["event_listeners"] = "test"

tests/core/test_initialization.py

@@ -129,6 +129,12 @@ def test_environment_values_override_configuration(self):
         prefix_used = config.registry.settings["settings_prefix"]
         self.assertEqual(prefix_used, "abc")
 
+    def test_statsd_plugin_isnt_included_by_default(self):
+        config = Configurator()
+        with mock.patch("kinto.plugins.statsd.StatsDService") as mocked:
+            kinto.core.initialize(config, "0.0.1", "prefix")
+        mocked.assert_not_called()
+
 
 class ProjectSettingsTest(unittest.TestCase):
     def settings(self, provided):
@@ -304,6 +310,7 @@ def unexpected_exceptions_are_reported(self):
 class MetricsConfigurationTest(unittest.TestCase):
     settings = {
         **kinto.core.DEFAULT_SETTINGS,
+        "includes": "kinto.plugins.statsd",
         "statsd_url": "udp://host:8080",
         "multiauth.policies": "basicauth",
     }
@@ -322,26 +329,6 @@ def setUp(self):
         self.config.registry.cache = {}
         self.config.registry.permission = {}
 
-    def test_setup_statsd_step_is_still_supported(self):
-        with mock.patch("warnings.warn") as mocked_warnings:
-            initialization.setup_statsd(self.config)
-            mocked_warnings.assert_called_with(
-                "``setup_statsd()`` is now deprecated. Use ``kinto.core.initialization.setup_metrics()`` instead.",
-                DeprecationWarning,
-            )
-        self.mocked.assert_called_with("host", 8080, "kinto.core")
-
-    def test_statsd_is_included_by_default(self):
-        kinto.core.initialize(self.config, "0.0.1", "name")
-
-        self.mocked.assert_called_with("host", 8080, "kinto.core")
-
-    def test_statsd_isnt_included_if_statsd_url_is_not_set(self):
-        self.config.add_settings({"statsd_url": None})
-        kinto.core.initialize(self.config, "0.0.1", "name")
-
-        self.mocked.assert_not_called()
-
     #
     # Backends.
     #

tests/plugins/test_history.py

@@ -31,11 +31,8 @@ class MetricsTest(HistoryWebTest):
     @classmethod
     def get_app_settings(cls, extras=None):
         settings = super().get_app_settings(extras)
-        settings.update(
-            **{
-                "statsd_url": "udp://127.0.0.1:8125",
-            }
-        )
+        settings["includes"] += " kinto.plugins.statsd"
+        settings["statsd_url"] = "udp://127.0.0.1:8125"
         return settings
 
     def test_a_statsd_timer_is_used_for_history_if_configured(self):