refactor: rename to clear_state

Author: heitorlessa

aws_lambda_powertools/logging/logger.py

@@ -264,13 +264,13 @@ def inject_lambda_context(
         lambda_handler: Callable[[Dict, Any], Any] = None,
         log_event: bool = None,
         correlation_id_path: str = None,
-        remove_custom_keys: bool = False,
+        clear_state: bool = False,
     ):
         """Decorator to capture Lambda contextual info and inject into logger
 
         Parameters
         ----------
-        remove_custom_keys : bool, optional
+        clear_state : bool, optional
             Instructs logger to remove any custom keys previously added
         lambda_handler : Callable
             Method to inject the lambda context
@@ -320,7 +320,7 @@ def handler(event, context):
                 self.inject_lambda_context,
                 log_event=log_event,
                 correlation_id_path=correlation_id_path,
-                remove_custom_keys=remove_custom_keys,
+                clear_state=clear_state,
             )
 
         log_event = resolve_truthy_env_var_choice(
@@ -332,7 +332,7 @@ def decorate(event, context):
             lambda_context = build_lambda_context_model(context)
             cold_start = _is_cold_start()
 
-            if remove_custom_keys:
+            if clear_state:
                 self.structure_logs(cold_start=cold_start, **lambda_context.__dict__)
             else:
                 self.append_keys(cold_start=cold_start, **lambda_context.__dict__)

docs/core/logger.md

@@ -232,7 +232,7 @@ We provide [built-in JMESPath expressions](#built-in-correlation-id-expressions)
 ### Appending additional keys
 
 !!! info "Custom keys are persisted across warm invocations"
-	Always set additional keys as part of your handler to ensure they have the latest value, or explicitly clear them with `remove_custom_keys=True`as explained above.
+	Always set additional keys as part of your handler to ensure they have the latest value, or explicitly clear them with `clear_state=True`as explained above.
 
 
 You can append additional keys using either mechanism:
@@ -427,17 +427,17 @@ You can remove any additional key from Logger state using `remove_keys`.
 	}
     ```
 
-#### Removing all custom keys
+#### Clearing all state
 
-Logger is commonly initialized in the global scope. Due to [Lambda Execution Context reuse](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html), this means that custom keys can be persisted across invocations. If you want all custom keys to be deleted, you can use `remove_custom_keys=True` param in `inject_lambda_context` decorator.
+Logger is commonly initialized in the global scope. Due to [Lambda Execution Context reuse](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html), this means that custom keys can be persisted across invocations. If you want all custom keys to be deleted, you can use `clear_state=True` param in `inject_lambda_context` decorator.
 
 !!! info
 	This is useful when you add multiple custom keys conditionally, instead of setting a default `None` value if not present. Any key with `None` value is automatically removed by Logger.
 
 !!! danger "This can have unintended side effects if you use Layers"
 	Lambda Layers code is imported before the Lambda handler.
 
-	This means that `remove_custom_keys=True` will instruct Logger to remove any keys previously added before Lambda handler execution proceeds.
+	This means that `clear_state=True` will instruct Logger to remove any keys previously added before Lambda handler execution proceeds.
 
 	You can either avoid running any code as part of Lambda Layers global scope, or override keys with their latest value as part of handler's execution.
 
@@ -448,7 +448,7 @@ Logger is commonly initialized in the global scope. Due to [Lambda Execution Con
 
     logger = Logger(service="payment")
 
-    @logger.inject_lambda_context(remove_custom_keys=True)
+    @logger.inject_lambda_context(clear_state=True)
     def handler(event, context):
 		if event.get("special_key"):
 			# Should only be available in the first request log

tests/functional/test_logger.py

@@ -564,12 +564,12 @@ def handler(event, context):
     assert "custom handler" in log
 
 
-def test_clear_keys_on_inject_lambda_context(lambda_context, stdout, service_name):
+def test_clear_state_on_inject_lambda_context(lambda_context, stdout, service_name):
     # GIVEN
     logger = Logger(service=service_name, stream=stdout)
 
-    # WHEN remove_custom_keys is set and a key was conditionally added in the first invocation
-    @logger.inject_lambda_context(remove_custom_keys=True)
+    # WHEN clear_state is set and a key was conditionally added in the first invocation
+    @logger.inject_lambda_context(clear_state=True)
     def handler(event, context):
         if event.get("add_key"):
             logger.append_keys(my_key="value")