Fix docs for log file name changes (#18913)

* fix docs * Update website/content/docs/agent/config/cli-flags.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/agent/config/cli-flags.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/agent/config/cli-flags.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
1 year ago · 5b3ab2eaed
1 changed files with 7 additions and 5 deletions
--- a/website/content/docs/agent/config/cli-flags.mdx
+++ b/website/content/docs/agent/config/cli-flags.mdx
@ -423,13 +423,15 @@ information.
 ## Log Options

 - `-log-file` ((#\_log_file)) - writes all the Consul agent log messages
-  to a file. This value is used as a prefix for the log file name. The current timestamp
-  is appended to the file name. If the value ends in a path separator, `consul-`
+  to a file at the path indicated by this flag. The filename defaults to `consul.log`.
+  When the log file rotates, this value is used as a prefix for the path to the log and the current timestamp is 
+  appended to the file name. If the value ends in a path separator, `consul-`
  will be appended to the value. If the file name is missing an extension, `.log`
  is appended. For example, setting `log-file` to `/var/log/` would result in a log
-  file path of `/var/log/consul-{timestamp}.log`. `log-file` can be combined with
-  [`-log-rotate-bytes`](#_log_rotate_bytes) and [-log-rotate-duration](#_log_rotate_duration)
-  for a fine-grained log rotation experience.
+  file path of `/var/log/consul.log`. `log-file` can be combined with
+  [`-log-rotate-bytes`](#_log_rotate_bytes) and [`-log-rotate-duration`](#_log_rotate_duration)
+  for a fine-grained log rotation experience. After rotation, the path and filename take the following form: 
+  `/var/log/consul-{timestamp}.log`

 - `-log-rotate-bytes` ((#\_log_rotate_bytes)) - to specify the number of
  bytes that should be written to a log before it needs to be rotated. Unless specified,