linting

Author: liustve

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/exporter/otlp/aws/logs/aws_batch_log_record_processor.py

@@ -18,7 +18,7 @@
 
 class AwsBatchLogRecordProcessor(BatchLogRecordProcessor):
     _BASE_LOG_BUFFER_BYTE_SIZE = (
-        1500  # Buffer size in bytes to account for log metadata not included in the body or attribute size calculation
+        1000  # Buffer size in bytes to account for log metadata not included in the body or attribute size calculation
     )
     _MAX_LOG_REQUEST_BYTE_SIZE = (
         1048576  # https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OTLPEndpoint.html
@@ -97,7 +97,8 @@ def _estimate_log_size(self, log: LogData, depth: int = 3) -> int:
         Estimates the size in bytes of a log by calculating the size of its body and its attributes
         and adding a buffer amount to account for other log metadata information.
         Will process complex log structures up to the specified depth limit.
-        If the depth limit of the log structure is exceeded, returns 0.
+        If the depth limit of the log structure is exceeded, returns truncates calculation
+        to everything up to that point.
 
         Args:
             log: The Log object to calculate size for
@@ -108,6 +109,7 @@ def _estimate_log_size(self, log: LogData, depth: int = 3) -> int:
         """
 
         # Use a queue to prevent excessive recursive calls.
+        # We calculate based on the size of the log record body and attributes for the log.
         queue: List[tuple[AnyValue, int]] = [(log.log_record.body, 0), (log.log_record.attributes, -1)]
 
         size: int = self._BASE_LOG_BUFFER_BYTE_SIZE
@@ -135,7 +137,6 @@ def _estimate_log_size(self, log: LogData, depth: int = 3) -> int:
                     continue
 
                 if current_depth <= depth:
-                    # Sequence has to be
                     if isinstance(next_val, Sequence):
                         for content in next_val:
                             new_queue.append((cast(AnyValue, content), current_depth + 1))
@@ -145,7 +146,7 @@ def _estimate_log_size(self, log: LogData, depth: int = 3) -> int:
                             size += len(key)
                             new_queue.append((content, current_depth + 1))
                 else:
-                    _logger.debug(f"Max log dept of {depth} exceeded. Log data size will not be accurately calculated.")
+                    _logger.debug(f"Max log depth of {depth} exceeded. Log data size will not be accurately calculated.")
 
             queue = new_queue