From 7a64a645eafa84575bb0c53478df341d3c427624 Mon Sep 17 00:00:00 2001 From: Kern Walster Date: Mon, 1 Jul 2024 13:03:00 -0700 Subject: [PATCH] fix: update fluentd-buffer-limit documentation `fluentd-buffer-limit` is the limit of the number of events buffered, not bytes. Signed-off-by: Kern Walster --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 566b622..811d8a7 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ The following additional arguments are supported for the `fluentd` shim logger b | fluentd-address | No | The address of the Fluentd server to connect to. By default, the `localhost:24224` address is used. | | fluentd-async-connect | No | Specifies if the logger connects to Fluentd in background. Defaults to `false`. | | fluentd-sub-second-precision | No | Generates logs in nanoseconds. Defaults to `true`. Note that this is in contrast to the default behaviour of fluentd log driver where it defaults to `false`. | -| fluentd-buffer-limit | No | Sets the number of events buffered on the memory in bytes. Defaults to `1048576` (1MB). | +| fluentd-buffer-limit | No | Sets the number of events buffered in memory. The total memory limit is approximately this limt * the average log line length. Defaults to `1048576`. | | fluentd-tag | No | Specifies the tag used for log messages. Defaults to the first 12 characters of container ID. | ## License