Skip to content

Commit 8a87ea5

Browse files
committed
Update Javadoc of BufferingAppenders.
1 parent 10c51c7 commit 8a87ea5

File tree

2 files changed

+4
-4
lines changed
  • powertools-logging
    • powertools-logging-log4j/src/main/java/software/amazon/lambda/powertools/logging/log4j
    • powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/logback

2 files changed

+4
-4
lines changed

powertools-logging/powertools-logging-log4j/src/main/java/software/amazon/lambda/powertools/logging/log4j/BufferingAppender.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
* <li>During Lambda INIT phase (no trace ID): logs are output directly</li>
7777
* <li>During Lambda execution (with trace ID): logs are buffered or output based on level</li>
7878
* <li>When buffer overflows: oldest logs are discarded and a warning is logged</li>
79-
* <li>On Lambda completion: remaining buffered logs can be flushed via {@link software.amazon.lambda.powertools.logging.PowertoolsLogging}</li>
79+
* <li>On Lambda completion: buffer is auto-cleared when used with {@code @Logging} annotation</li>
8080
* </ul>
8181
*
8282
* @see software.amazon.lambda.powertools.logging.PowertoolsLogging#flushBuffer()

powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/logback/BufferingAppender.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
* <ul>
4040
* <li><strong>Trace-based buffering:</strong> Groups logs by AWS X-Ray trace ID</li>
4141
* <li><strong>Selective output:</strong> Only buffers logs at or below configured verbosity level</li>
42-
* <li><strong>Auto-flush on errors:</strong> Automatically outputs buffered logs when ERROR events occur</li>
42+
* <li><strong>Auto-flush on errors:</strong> Automatically outputs buffered logs when ERROR/FATAL events occur</li>
4343
* <li><strong>Memory management:</strong> Prevents memory leaks with configurable buffer size limits</li>
4444
* <li><strong>Overflow protection:</strong> Warns when logs are discarded due to buffer limits</li>
4545
* </ul>
@@ -58,15 +58,15 @@
5858
* <ul>
5959
* <li><strong>bufferAtVerbosity:</strong> Log level to buffer (default: DEBUG). Logs at this level and below are buffered</li>
6060
* <li><strong>maxBytes:</strong> Maximum buffer size in bytes per trace ID (default: 20480)</li>
61-
* <li><strong>flushOnErrorLog:</strong> Whether to flush buffer on ERROR logs (default: true)</li>
61+
* <li><strong>flushOnErrorLog:</strong> Whether to flush buffer on ERROR/FATAL logs (default: true)</li>
6262
* </ul>
6363
*
6464
* <h3>Behavior:</h3>
6565
* <ul>
6666
* <li>During Lambda INIT phase (no trace ID): logs are output directly</li>
6767
* <li>During Lambda execution (with trace ID): logs are buffered or output based on level</li>
6868
* <li>When buffer overflows: oldest logs are discarded and a warning is logged</li>
69-
* <li>On Lambda completion: remaining buffered logs can be flushed via {@link software.amazon.lambda.powertools.logging.PowertoolsLogging}</li>
69+
* <li>On Lambda completion: buffer is auto-cleared when used with {@code @Logging} annotation</li>
7070
* </ul>
7171
*
7272
* @see software.amazon.lambda.powertools.logging.PowertoolsLogging#flushBuffer()

0 commit comments

Comments
 (0)