formatting

Author: danilohgds

python/aws_lambda_powertools/logging/logger.py

@@ -16,7 +16,7 @@
 
 
 def logger_setup(
-        service: str = "service_undefined", level: str = "INFO", sampling_rate: float = 0.0, **kwargs
+    service: str = "service_undefined", level: str = "INFO", sampling_rate: float = 0.0, **kwargs
 ):
     """Setups root logger to format statements in JSON.
 
@@ -29,7 +29,7 @@ def logger_setup(
         service name
     LOG_LEVEL: str
         logging level (e.g. INFO, DEBUG)
-    POWERTOOLS_SAMPLE_RATE: str
+    POWERTOOLS_LOGGER_SAMPLE_RATE: str
         samping rate ranging from 0 to 1, float precision
 
     Parameters
@@ -65,7 +65,7 @@ def logger_setup(
 
     """
     service = os.getenv("POWERTOOLS_SERVICE_NAME") or service
-    sampling_rate = os.getenv("POWERTOOLS_SAMPLE_RATE") or sampling_rate
+    sampling_rate = os.getenv("POWERTOOLS_LOGGER_SAMPLE_RATE") or sampling_rate
     log_level = os.getenv("LOG_LEVEL") or level
     logger = logging.getLogger(name=service)
 
@@ -75,7 +75,9 @@ def logger_setup(
         if sampling_rate and random.random() <= float(sampling_rate):
             log_level = logging.DEBUG
     except ValueError:
-        logger.debug("POWERTOOLS_SAMPLE_RATE provided value {0} is not valid.".format(sampling_rate))
+        logger.debug(
+            "POWERTOOLS_LOGGER_SAMPLE_RATE provided value {0} is not valid.".format(sampling_rate)
+        )
 
     logger.setLevel(log_level)
 
@@ -88,7 +90,7 @@ def logger_setup(
 
 
 def logger_inject_lambda_context(
-        lambda_handler: Callable[[Dict, Any], Any] = None, log_event: bool = False
+    lambda_handler: Callable[[Dict, Any], Any] = None, log_event: bool = False
 ):
     """Decorator to capture Lambda contextual info and inject into struct logging
 
@@ -183,12 +185,12 @@ def __is_cold_start() -> str:
 
 
 def log_metric(
-        name: str,
-        namespace: str,
-        unit: MetricUnit,
-        value: float = 0,
-        service: str = "service_undefined",
-        **dimensions,
+    name: str,
+    namespace: str,
+    unit: MetricUnit,
+    value: float = 0,
+    service: str = "service_undefined",
+    **dimensions,
 ):
     """Logs a custom metric in a statsD-esque format to stdout.
 

python/tests/functional/test_aws_lambda_logging.py

@@ -112,4 +112,4 @@ class X:
 
     log_dict = json.loads(stdout.getvalue())
 
-    assert log_dict["message"]["x"].startswith("<")
+    assert log_dict["message"]["x"].startswith("<")

python/tests/functional/test_logger.py

@@ -81,11 +81,11 @@ def test_setup_service_env_var(monkeypatch, root_logger, stdout):
 
 
 def test_setup_sampling_rate(monkeypatch, root_logger, stdout):
-    # GIVEN samping rate is explicitly defined via POWERTOOLS_SAMPLE_RATE env
+    # GIVEN samping rate is explicitly defined via POWERTOOLS_LOGGER_SAMPLE_RATE env
     # WHEN logger is setup
-    # THEN sampling rate should be equals POWERTOOLS_SAMPLE_RATE value
+    # THEN sampling rate should be equals POWERTOOLS_LOGGER_SAMPLE_RATE value
     sampling_rate = "0.1"
-    monkeypatch.setenv("POWERTOOLS_SAMPLE_RATE", sampling_rate)
+    monkeypatch.setenv("POWERTOOLS_LOGGER_SAMPLE_RATE", sampling_rate)
 
     logger = logger_setup()
     logger.info("Hello")
@@ -141,7 +141,7 @@ def handler(event, context):
 
 
 def test_inject_lambda_context_log_event_request_env_var(
-        monkeypatch, root_logger, stdout, lambda_context
+    monkeypatch, root_logger, stdout, lambda_context
 ):
     # GIVEN a lambda function is decorated with logger instructed to log event
     # via POWERTOOLS_LOGGER_LOG_EVENT env
@@ -172,7 +172,7 @@ def handler(event, context):
 
 
 def test_inject_lambda_context_log_no_request_by_default(
-        monkeypatch, root_logger, stdout, lambda_context
+    monkeypatch, root_logger, stdout, lambda_context
 ):
     # GIVEN a lambda function is decorated with logger
     # WHEN logger is setup
@@ -293,12 +293,12 @@ def test_log_metric_multiple_dimensions(capsys):
     "invalid_input,expected",
     [
         (
-                {"unit": "seconds"},
-                "MONITORING|0|Seconds|test_metric|DemoApp|service=service_undefined\n",
+            {"unit": "seconds"},
+            "MONITORING|0|Seconds|test_metric|DemoApp|service=service_undefined\n",
         ),
         (
-                {"unit": "Seconds", "customer": None, "charge_id": "123", "payment_status": ""},
-                "MONITORING|0|Seconds|test_metric|DemoApp|service=service_undefined,charge_id=123\n",
+            {"unit": "Seconds", "customer": None, "charge_id": "123", "payment_status": ""},
+            "MONITORING|0|Seconds|test_metric|DemoApp|service=service_undefined,charge_id=123\n",
         ),
     ],
     ids=["metric unit as string lower case", "empty dimension value"],