docs(examples): standardize lambda handler function name (#2192)

Author: leandrodamascena

examples/logger/sam/template.yaml

@@ -5,7 +5,7 @@ Description: AWS Lambda Powertools Tracer doc examples
 Globals:
   Function:
     Timeout: 5
-    Runtime: python3.9
+    Runtime: python3.10
     Tracing: Active
     Environment:
       Variables:

examples/logger/src/append_keys.py

@@ -4,7 +4,7 @@
 logger = Logger()
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     order_id = event.get("order_id")
 
     # this will ensure order_id key always has the latest value before logging

examples/logger/src/append_keys_extra.py

@@ -4,7 +4,7 @@
 logger = Logger()
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     fields = {"request_id": "1123"}
     logger.info("Collecting payment", extra=fields)
 

examples/logger/src/append_keys_kwargs.py

@@ -4,7 +4,7 @@
 logger = Logger()
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     logger.info("Collecting payment", request_id="1123")
 
     return "hello world"

examples/logger/src/append_keys_vs_extra.py

@@ -12,7 +12,7 @@ class PaymentError(Exception):
     ...
 
 
-def handler(event, context):
+def lambda_handler(event, context):
     logger.append_keys(payment_id="123456789")
     charge_id = event.get("charge_id", "")
 

examples/logger/src/bring_your_own_formatter_from_scratch.py

@@ -39,5 +39,5 @@ def format(self, record: logging.LogRecord) -> str:  # noqa: A003
 
 
 @logger.inject_lambda_context
-def handler(event, context):
+def lambda_handler(event, context):
     logger.info("Collecting payment")

examples/logger/src/clear_state.py

@@ -5,7 +5,7 @@
 
 
 @logger.inject_lambda_context(clear_state=True)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     if event.get("special_key"):
         # Should only be available in the first request log
         # as the second request doesn't contain `special_key`

examples/logger/src/enabling_boto_logging.py

@@ -12,7 +12,7 @@
 client = boto3.client("s3")
 
 
-def handler(event: Dict, context: LambdaContext) -> List:
+def lambda_handler(event: Dict, context: LambdaContext) -> List:
     response = client.list_buckets()
 
     return response.get("Buckets", [])

examples/logger/src/fake_lambda_context_for_logger_module.py

@@ -5,7 +5,7 @@
 
 
 @logger.inject_lambda_context
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     logger.info("Collecting payment")
 
     return "hello world"

examples/logger/src/inject_lambda_context.py

@@ -5,7 +5,7 @@
 
 
 @logger.inject_lambda_context
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     logger.info("Collecting payment")
 
     # You can log entire objects too

examples/logger/src/log_incoming_event.py

@@ -5,5 +5,5 @@
 
 
 @logger.inject_lambda_context(log_event=True)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     return "hello world"

examples/logger/src/logger_reuse.py

@@ -7,7 +7,7 @@
 
 
 @logger.inject_lambda_context
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     inject_payment_id(context=event)
     logger.info("Collecting payment")
     return "hello world"

examples/logger/src/logging_exceptions.py

@@ -7,7 +7,7 @@
 logger = Logger()
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     try:
         ret = requests.get(ENDPOINT)
         ret.raise_for_status()

examples/logger/src/logging_inheritance_bad.py

@@ -10,7 +10,7 @@
 
 
 @logger.inject_lambda_context
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     inject_payment_id(context=event)
 
     return "hello world"

examples/logger/src/logging_inheritance_good.py

@@ -10,7 +10,7 @@
 
 
 @logger.inject_lambda_context
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     inject_payment_id(context=event)
 
     return "hello world"

examples/logger/src/logging_uncaught_exceptions.py

@@ -7,7 +7,7 @@
 logger = Logger(log_uncaught_exceptions=True)
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     ret = requests.get(ENDPOINT)
     # HTTP 4xx/5xx status will lead to requests.HTTPError
     # Logger will log this exception before this program exits non-successfully

examples/logger/src/remove_keys.py

@@ -4,7 +4,7 @@
 logger = Logger()
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     logger.append_keys(sample_key="value")
     logger.info("Collecting payment")
 

examples/logger/src/sampling_debug_logs.py

@@ -6,7 +6,7 @@
 logger = Logger(service="payment", sample_rate=0.1)
 
 
-def handler(event: dict, context: LambdaContext):
+def lambda_handler(event: dict, context: LambdaContext):
     logger.debug("Verifying whether order_id is present")
     logger.info("Collecting payment")
 

examples/logger/src/set_correlation_id.py

@@ -5,7 +5,7 @@
 
 
 @logger.inject_lambda_context(correlation_id_path="headers.my_request_id_header")
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     logger.debug(f"Correlation ID => {logger.get_correlation_id()}")
     logger.info("Collecting payment")
 

examples/logger/src/set_correlation_id_jmespath.py

@@ -6,7 +6,7 @@
 
 
 @logger.inject_lambda_context(correlation_id_path=correlation_paths.API_GATEWAY_REST)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     logger.debug(f"Correlation ID => {logger.get_correlation_id()}")
     logger.info("Collecting payment")
 

examples/logger/src/set_correlation_id_method.py

@@ -5,7 +5,7 @@
 logger = Logger()
 
 
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     request = APIGatewayProxyEvent(event)
 
     logger.set_correlation_id(request.request_context.request_id)

examples/metrics/sam/template.yaml

@@ -5,7 +5,7 @@ Description: AWS Lambda Powertools Metrics doc examples
 Globals:
   Function:
     Timeout: 5
-    Runtime: python3.9
+    Runtime: python3.10
     Tracing: Active
     Environment:
       Variables:

examples/tracer/sam/template.yaml

@@ -5,7 +5,7 @@ Description: AWS Lambda Powertools Tracer doc examples
 Globals:
   Function:
     Timeout: 5
-    Runtime: python3.9
+    Runtime: python3.10
     Tracing: Active
     Environment:
       Variables:

examples/tracer/src/capture_lambda_handler.py

@@ -10,6 +10,6 @@ def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return collect_payment(charge_id=charge_id)

examples/tracer/src/capture_method.py

@@ -11,6 +11,6 @@ def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return collect_payment(charge_id=charge_id)

examples/tracer/src/capture_method_async.py

@@ -14,6 +14,6 @@ async def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return asyncio.run(collect_payment(charge_id=charge_id))

examples/tracer/src/capture_method_async_concurrency.py

@@ -26,6 +26,6 @@ async def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return asyncio.run(collect_payment(charge_id=charge_id))

examples/tracer/src/capture_method_context_manager.py

@@ -19,7 +19,7 @@ def collect_payment(charge_id: str) -> Generator[str, None, None]:
 
 @tracer.capture_lambda_handler
 @logger.inject_lambda_context
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     with collect_payment(charge_id=charge_id) as receipt_id:
         logger.info(f"Processing payment collection for charge {charge_id} with receipt {receipt_id}")

examples/tracer/src/capture_method_generators.py

@@ -12,6 +12,6 @@ def collect_payment(charge_id: str) -> Generator[str, None, None]:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return next(collect_payment(charge_id=charge_id))

examples/tracer/src/disable_capture_error.py

@@ -24,7 +24,7 @@ def collect_payment(charge_id: str) -> dict:
 
 
 @tracer.capture_lambda_handler(capture_error=False)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     ret = collect_payment(charge_id=charge_id)
 

examples/tracer/src/disable_capture_response.py

@@ -13,6 +13,6 @@ def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler(capture_response=False)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return collect_payment(charge_id=charge_id)

examples/tracer/src/disable_capture_response_streaming_body.py

@@ -24,7 +24,7 @@ def fetch_payment_report(payment_id: str) -> StreamingBody:
 
 
 @tracer.capture_lambda_handler(capture_response=False)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     payment_id = event.get("payment_id", "")
     report = fetch_payment_report(payment_id=payment_id)
     return report.read().decode()

examples/tracer/src/ignore_endpoints.py

@@ -28,7 +28,7 @@ def collect_payment(charge_id: str) -> dict:
 
 
 @tracer.capture_lambda_handler(capture_error=False)
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     ret = collect_payment(charge_id=charge_id)
 

examples/tracer/src/patch_modules.py

@@ -9,7 +9,7 @@
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     ret = requests.get("https://httpbin.org/get")
     ret.raise_for_status()
 

examples/tracer/src/put_trace_annotations.py

@@ -10,6 +10,6 @@ def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return collect_payment(charge_id=charge_id)

examples/tracer/src/put_trace_metadata.py

@@ -9,7 +9,7 @@ def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     payment_context = {
         "charge_id": event.get("charge_id", ""),
         "merchant_id": event.get("merchant_id", ""),

examples/tracer/src/sdk_escape_hatch.py

@@ -9,7 +9,7 @@ def collect_payment(charge_id: str) -> str:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     with tracer.provider.in_subsegment("## collect_payment") as subsegment:
         subsegment.put_annotation(key="PaymentId", value=charge_id)

examples/tracer/src/tracer_reuse.py

@@ -7,6 +7,6 @@
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> str:
+def lambda_handler(event: dict, context: LambdaContext) -> str:
     charge_id = event.get("charge_id", "")
     return collect_payment(charge_id=charge_id)

examples/tracer/src/tracing_aiohttp.py

@@ -20,6 +20,6 @@ async def collect_payment(charge_id: str) -> dict:
 
 
 @tracer.capture_lambda_handler
-def handler(event: dict, context: LambdaContext) -> dict:
+def lambda_handler(event: dict, context: LambdaContext) -> dict:
     charge_id = event.get("charge_id", "")
     return asyncio.run(collect_payment(charge_id=charge_id))