Adding documentation

Author: leandrodamascena

aws_lambda_powertools/logging/buffer/config.py

@@ -43,7 +43,6 @@ def _validate_inputs(
         max_size: int,
         minimum_log_level: str,
         flush_on_error: bool,
-        compress: bool,
     ) -> None:
         """
         Validate configuration inputs.
@@ -65,9 +64,6 @@ def _validate_inputs(
         if not isinstance(flush_on_error, bool):
             raise ValueError("flush_on_error must be a boolean")
 
-        if not isinstance(compress, bool):
-            raise ValueError("compress must be a boolean")
-
     @property
     def max_size(self) -> int:
         """Maximum buffer size in bytes."""
@@ -82,8 +78,3 @@ def minimum_log_level(self) -> str:
     def flush_on_error(self) -> bool:
         """Flag to flush buffer on error."""
         return self._flush_on_error
-
-    @property
-    def compress(self) -> bool:
-        """Flag to compress buffered logs."""
-        return self._compress

docs/core/logger.md

@@ -562,88 +562,78 @@ Use the `@logger.inject_lambda_context` decorator to automatically flush buffere
 
 ##### Flushing manually
 
+<center>
 ```mermaid
 sequenceDiagram
     participant Client
     participant Lambda
     participant Logger
     participant CloudWatch
-
     Client->>Lambda: Invoke Lambda
     Lambda->>Logger: Initialize with DEBUG level buffering
     Logger-->>Lambda: Logger buffer ready
-
     Lambda->>Logger: logger.debug("First debug log")
     Logger-->>Logger: Buffer first debug log
-
     Lambda->>Logger: logger.info("Info log")
     Logger->>CloudWatch: Directly log info message
-
     Lambda->>Logger: logger.debug("Second debug log")
     Logger-->>Logger: Buffer second debug log
-
     Lambda->>Logger: logger.flush_buffer()
     Logger->>CloudWatch: Flush buffered debug logs to CloudWatch
-
     Lambda->>Client: Return execution result
-
 ```
+<i>Flushing buffer manually</i>
+</center>
 
 ##### Flushing on error
 
+<center>
 ```mermaid
 sequenceDiagram
     participant Client
     participant Lambda
     participant Logger
     participant CloudWatch
-
     Client->>Lambda: Invoke Lambda
     Lambda->>Logger: Initialize with DEBUG level buffering
     Logger-->>Lambda: Logger buffer ready
-
     Lambda->>Logger: logger.debug("First log")
     Logger-->>Logger: Buffer first debug log
-
     Lambda->>Logger: logger.debug("Second log")
     Logger-->>Logger: Buffer second debug log
-
     Lambda->>Logger: logger.debug("Third log")
     Logger-->>Logger: Buffer third debug log
-
     Lambda->>Lambda: Exception occurs
     Lambda->>Logger: logger.error("Error details")
     Logger->>CloudWatch: Send buffered debug logs
     Logger->>CloudWatch: Send error log
-
     Lambda->>Client: Raise exception
 ```
+<i>Flushing buffer when an error happens</i>
+</center>
 
 ##### Flushing when uncaught exception happens
 
+<center>
 ```mermaid
 sequenceDiagram
     participant Client
     participant Lambda
     participant Logger
     participant CloudWatch
-
     Client->>Lambda: Invoke Lambda
     Lambda->>Logger: Using decorator @logger.inject_lambda_context(flush_buffer_on_uncaught_error=True)
     Logger-->>Lambda: Logger context injected
-
     Lambda->>Logger: logger.debug("First log")
     Logger-->>Logger: Buffer first debug log
-
     Lambda->>Logger: logger.debug("Second log")
     Logger-->>Logger: Buffer second debug log
-
     Lambda->>Lambda: Uncaught Exception
     Lambda->>CloudWatch: Automatically send buffered debug logs
-
     Lambda->>Client: Raise uncaught exception
-
 ```
+<i>Flushing buffer when an uncaught exception happens</i>
+</center>
 
 #### Common buffering questions
 

tests/unit/logger/required_dependencies/test_logger_buffer_config.py

@@ -11,7 +11,6 @@ def test_default_configuration():
     assert config_buffer.max_size == 20480
     assert config_buffer.minimum_log_level == "DEBUG"
     assert config_buffer.flush_on_error is True
-    assert config_buffer.compress is False
 
 
 def test_custom_configuration():
@@ -20,14 +19,12 @@ def test_custom_configuration():
         max_size=51200,
         minimum_log_level="WARNING",
         flush_on_error=False,
-        compress=True,
     )
 
     # THEN configuration is set with provided values
     assert config_buffer.max_size == 51200
     assert config_buffer.minimum_log_level == "WARNING"
     assert config_buffer.flush_on_error is False
-    assert config_buffer.compress is True
 
 
 def test_invalid_max_size_negative():
@@ -79,13 +76,3 @@ def test_invalid_flush_on_error():
     with pytest.raises(ValueError, match="flush_on_error must be a boolean"):
         # THEN a ValueError is raised
         LoggerBufferConfig(flush_on_error=invalid_flush_on_error)
-
-
-def test_invalid_compress():
-    # GIVEN an invalid compress type
-    invalid_compress = "False"
-
-    # WHEN creating a LoggerBufferConfig / THEN
-    with pytest.raises(ValueError, match="compress must be a boolean"):
-        # THEN a ValueError is raised
-        LoggerBufferConfig(compress=invalid_compress)