Merge pull request #125 from gridsmartercities/log_func_name

added function name to all messages output by log decorator

Author: eulogio-gutierrez

aws_lambda_decorators/decorators.py

@@ -14,8 +14,8 @@
 LOGGER = get_logger(__name__)
 
 
-PARAM_LOG_MESSAGE = "Parameters: %s"
-RESPONSE_LOG_MESSAGE = "Response: %s"
+PARAM_LOG_MESSAGE = "Function: %s, Parameters: %s"
+RESPONSE_LOG_MESSAGE = "Function: %s, Response: %s"
 EXCEPTION_LOG_MESSAGE = "%s: %s in argument %s for path %s"
 EXCEPTION_LOG_MESSAGE_PATHLESS = "%s: %s in argument %s"
 ERROR_MESSAGE = "Error extracting parameters"
@@ -164,10 +164,10 @@ def log(parameters=False, response=False):
     def decorator(func):
         def wrapper(*args, **kwargs):
             if parameters:
-                LOGGER.info(PARAM_LOG_MESSAGE, args)
+                LOGGER.info(PARAM_LOG_MESSAGE, func.__name__, args)
             func_response = func(*args, **kwargs)
             if response:
-                LOGGER.info(RESPONSE_LOG_MESSAGE, func_response)
+                LOGGER.info(RESPONSE_LOG_MESSAGE, func.__name__, func_response)
             return func_response
         return wrapper
     return decorator

examples/test_examples.py

@@ -192,8 +192,8 @@ def test_log_example(mock_logger):
 
         # and check the log messages were produced.
         mock_logger.info.assert_has_calls([
-            call("Parameters: %s", ("Hello!",)),
-            call("Response: %s", "Done!")
+            call("Function: %s, Parameters: %s", "log_example", ("Hello!",)),
+            call("Function: %s, Response: %s", "log_example", "Done!")
         ])
 
     @patch("boto3.resource")

tests/test_decorators.py

@@ -484,7 +484,8 @@ def handler(event, context, an_other):  # noqa
 
         handler("first", "{\"tests\": \"a\"}", "another")
 
-        mock_logger.info.assert_called_once_with("Parameters: %s", ("first", "{\"tests\": \"a\"}", "another"))
+        mock_logger.info.assert_called_once_with(
+            "Function: %s, Parameters: %s", "handler", ("first", "{\"tests\": \"a\"}", "another"))
 
     @patch("aws_lambda_decorators.decorators.LOGGER")
     def test_log_decorator_can_log_response(self, mock_logger):  # noqa: pylint - no-self-use
@@ -495,7 +496,7 @@ def handler():
 
         handler()
 
-        mock_logger.info.assert_called_once_with("Response: %s", {"statusCode": 201})
+        mock_logger.info.assert_called_once_with("Function: %s, Response: %s", "handler", {"statusCode": 201})
 
     @patch("boto3.client")
     def test_get_valid_ssm_parameter(self, mock_boto_client):