filter provider generated logs from platform logger

Author: jaymccon

python/rpdk/python/templates/handlers.py

@@ -1,3 +1,4 @@
+import logging
 from typing import Any, MutableMapping
 
 from {{support_lib_pkg}} import (
@@ -13,6 +14,9 @@
 
 from .models import ResourceModel, TResourceModel
 
+# Use this logger to forward log messages to CloudWatch Logs.
+LOG = logging.getLogger(__name__)
+
 resource = Resource(ResourceModel)
 test_entrypoint = resource.test_entrypoint
 

src/aws_cloudformation_rpdk_python_lib/log_delivery.py

@@ -6,6 +6,13 @@
 import boto3  # type: ignore
 
 
+class ProviderFilter(logging.Filter):
+    PROVIDER = ""
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        return not record.name.startswith(self.PROVIDER)
+
+
 class ProviderLogHandler(logging.Handler):
     def __init__(self, group: str, stream: str, creds: Mapping[str, str]):
         logging.Handler.__init__(self)
@@ -24,6 +31,12 @@ def setup(cls, event_data: Mapping[str, Any]) -> None:
         stream_suffix = event_data.get("requestData", {}).get(
             "logicalResourceId", event_data.get("action")
         )
+
+        # filter provider messages from platform
+        ProviderFilter.PROVIDER = event_data["resourceType"].replace("::", "_").lower()
+        logging.getLogger().handlers[0].addFilter(ProviderFilter())
+
+        # add log handler to root, so that provider gets plugin logs too
         if log_creds and log_group:
             log_handler = cls(
                 group=log_group,

tests/lib/log_delivery_test.py

@@ -3,7 +3,10 @@
 from unittest.mock import DEFAULT, Mock, create_autospec, patch
 
 import pytest
-from aws_cloudformation_rpdk_python_lib.log_delivery import ProviderLogHandler
+from aws_cloudformation_rpdk_python_lib.log_delivery import (
+    ProviderFilter,
+    ProviderLogHandler,
+)
 
 
 @pytest.fixture
@@ -28,16 +31,36 @@ def mock_provider_handler():
     return plh
 
 
+@pytest.mark.parametrize(
+    "logger", [("aa_bb_cc", False), ("aws_cloudformation_rpdk_python_lib", True)]
+)
+def test_provider_filter(logger):
+    log_name, expected = logger
+    ProviderFilter.PROVIDER = "aa_bb_cc"
+    log_filter = ProviderFilter()
+    record = logging.LogRecord(
+        name=log_name,
+        level=123,
+        pathname="abc",
+        lineno=123,
+        msg="test",
+        args=[],
+        exc_info=False,
+    )
+    assert log_filter.filter(record) == expected
+
+
 def test_setup_with_provider_creds(mock_logger):
     payload = {
+        "resourceType": "Foo::Bar::Baz",
         "requestData": {
             "providerCredentials": {
                 "accessKeyId": "AKI",
                 "secretAccessKey": "SAK",
                 "sessionToken": "ST",
             },
             "providerLogGroupName": "test_group",
-        }
+        },
     }
     with patch(
         "aws_cloudformation_rpdk_python_lib.log_delivery.logging.getLogger",
@@ -67,20 +90,20 @@ def test_setup_without_provider_creds(mock_logger):
             ".__init__",
             autospec=True,
         ) as mock___init__:
-            ProviderLogHandler.setup({})
-            ProviderLogHandler.setup({"requestData": {}})
-            ProviderLogHandler.setup({"requestData": {"providerLogGroupName": "test"}})
-            ProviderLogHandler.setup(
-                {
-                    "requestData": {
-                        "providerCredentials": {
-                            "accessKeyId": "AKI",
-                            "secretAccessKey": "SAK",
-                            "sessionToken": "ST",
-                        }
-                    }
+            payload = {"resourceType": "Foo::Bar::Baz"}
+            ProviderLogHandler.setup(payload)
+            payload["requestData"] = {}
+            ProviderLogHandler.setup(payload)
+            payload["requestData"] = {"providerLogGroupName": "test"}
+            ProviderLogHandler.setup(payload)
+            payload["requestData"] = {
+                "providerCredentials": {
+                    "accessKeyId": "AKI",
+                    "secretAccessKey": "SAK",
+                    "sessionToken": "ST",
                 }
-            )
+            }
+            ProviderLogHandler.setup(payload)
     mock___init__.assert_not_called()
     patched_logger.return_value.addHandler.assert_not_called()