Merge remote-tracking branch 'origin/main' into centralized-check-registry

Author: leplatrem

src/dockerflow/checks/registry.py

@@ -193,6 +193,10 @@ def _build_results_payload(
     max_level = 0
 
     for name, errors in checks_results:
+        # Log check results with appropriate level.
+        for error in errors:
+            logger.log(error.level, "%s: %s", error.id, error.msg)
+
         errors = [e for e in errors if e.id not in silenced_check_ids]
         level = max([0] + [e.level for e in errors])
 

src/dockerflow/django/views.py

@@ -1,6 +1,8 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
+import logging
+
 from django.conf import settings
 from django.core.checks.registry import registry as django_check_registry
 from django.http import HttpResponse, HttpResponseNotFound, JsonResponse
@@ -15,6 +17,9 @@
 )
 
 
+logger = logging.getLogger("dockerflow.django")
+
+
 def version(request):
     """
     Returns the contents of version.json or a 404.

src/dockerflow/flask/app.py

@@ -354,6 +354,17 @@ def my_version(root):
         """
         self._version_callback = func
 
+    @property
+    def checks(self):
+        """
+        Backwards compatibility alias.
+        """
+        message = (
+            "`dockerflow.checks` is deprecated, use `checks.get_checks()` instead."
+        )
+        warnings.warn(message, DeprecationWarning)
+        return checks.get_checks()
+
     def init_check(self, check, obj):
         """
         Backwards compatibility method.
@@ -366,8 +377,6 @@ def check(self, func=None, name=None):
         """
         Backwards compatibility method.
         """
-        message = (
-            "`dockerflow.check()` is deprecated, use `checks.register()` instead."
-        )
+        message = "`dockerflow.check()` is deprecated, use `checks.register()` instead."
         warnings.warn(message, DeprecationWarning)
         return checks.register(func, name)

src/dockerflow/sanic/app.py

@@ -255,6 +255,17 @@ async def my_version(root):
         """
         self._version_callback = func
 
+    @property
+    def checks(self):
+        """
+        Backwards compatibility alias.
+        """
+        message = (
+            "`dockerflow.checks` is deprecated, use `checks.get_checks()` instead."
+        )
+        warnings.warn(message, DeprecationWarning)
+        return checks.get_checks()
+
     def init_check(self, check, obj):
         """
         Backwards compatibility method.

tests/django/test_django.py

@@ -101,6 +101,22 @@ def test_heartbeat_silenced(client, settings):
     assert "error" not in content["details"]
 
 
+@pytest.mark.django_db
+def test_heartbeat_logging(dockerflow_middleware, reset_checks, rf, settings, caplog):
+    request = rf.get("/__heartbeat__")
+    settings.DOCKERFLOW_CHECKS = [
+        "tests.django.django_checks.warning",
+        "tests.django.django_checks.error",
+    ]
+    checks.register()
+
+    with caplog.at_level(logging.INFO, logger="dockerflow.checks.registry"):
+        dockerflow_middleware.process_request(request)
+    logged = [(record.levelname, record.message) for record in caplog.records]
+    assert ("ERROR", "tests.checks.E001: some error") in logged
+    assert ("WARNING", "tests.checks.W001: some warning") in logged
+
+
 @pytest.mark.django_db
 def test_lbheartbeat_makes_no_db_queries(dockerflow_middleware, rf):
     queries = CaptureQueriesContext(connection)

tests/flask/test_flask.py

@@ -162,6 +162,23 @@ def warning_check():
     assert "warning_check" not in details
 
 
+def test_heartbeat_logging(app, dockerflow, caplog):
+    @checks.register
+    def error_check():
+        return [checks.Error("some error", id="tests.checks.E001")]
+
+    @checks.register()
+    def warning_check():
+        return [checks.Warning("some warning", id="tests.checks.W001")]
+
+    with caplog.at_level(logging.INFO, logger="dockerflow.checks.registry"):
+        app.test_client().get("/__heartbeat__")
+
+    logged = [(record.levelname, record.message) for record in caplog.records]
+    assert ("ERROR", "tests.checks.E001: some error") in logged
+    assert ("WARNING", "tests.checks.W001: some warning") in logged
+
+
 def test_lbheartbeat_makes_no_db_queries(dockerflow, app):
     with app.app_context():
         assert len(get_debug_queries()) == 0
@@ -498,6 +515,8 @@ def test_checks_imports():
 
 
 def test_heartbeat_checks_legacy(dockerflow, client):
+    dockerflow.checks.clear()
+
     @dockerflow.check
     def error_check():
         return [checks.Error("some error", id="tests.checks.E001")]

tests/sanic/test_sanic.py

@@ -178,6 +178,23 @@ def warning_check():
     assert "warning_check" in details
 
 
+def test_heartbeat_logging(dockerflow, test_client, caplog):
+    @checks.register
+    def error_check():
+        return [checks.Error("some error", id="tests.checks.E001")]
+
+    @checks.register()
+    def warning_check():
+        return [checks.Warning("some warning", id="tests.checks.W001")]
+
+    with caplog.at_level(logging.INFO, logger="dockerflow.checks.registry"):
+        _, response = test_client.get("/__heartbeat__")
+
+    logged = [(record.levelname, record.message) for record in caplog.records]
+    assert ("ERROR", "tests.checks.E001: some error") in logged
+    assert ("WARNING", "tests.checks.W001: some warning") in logged
+
+
 def test_redis_check(dockerflow_redis, mocker, test_client):
     assert "check_redis_connected" in checks.get_checks()
     mocker.patch.object(sanic_redis.core, "from_url", fake_redis)
@@ -259,6 +276,8 @@ def hostile_callback(request):
 
 
 def test_heartbeat_checks_legacy(dockerflow, test_client):
+    dockerflow.checks.clear()
+
     @dockerflow.check
     def error_check():
         return [checks.Error("some error", id="tests.checks.E001")]