From a4d99a87f4e4d1be580058604835c9d561da3298 Mon Sep 17 00:00:00 2001 From: Cathy Chang Date: Fri, 19 Feb 2021 06:37:55 -0800 Subject: [PATCH] docs: clarify log_rotate_max_files --- website/content/docs/configuration/index.mdx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/website/content/docs/configuration/index.mdx b/website/content/docs/configuration/index.mdx index 6dacc4b69..12937e8ab 100644 --- a/website/content/docs/configuration/index.mdx +++ b/website/content/docs/configuration/index.mdx @@ -254,8 +254,11 @@ testing. log should be written to before it needs to be rotated. Must be a duration value such as 30s. -- `log_rotate_max_files` `(int: 0)` - Specifies the maximum number of older log - file archives to keep. If 0 no files are ever deleted. +- `log_rotate_max_files` `(int: 0)` - Specifies the maximum number of older + log file archives to keep, not including the log file currently being + written. If set to 0 no files are ever deleted. Note that the total number + of log files, for each of `stderr` and `stdout`, will be 1 greater than the + `log_rotate_max_files` value. - `name` `(string: [hostname])` - Specifies the name of the local node. This value is used to identify individual agents. When specified on a server, the