status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Ashesh Vidyut 2023-09-22 19:22:35 +05:30 committed by GitHub
parent eb7e20307c
commit 5b3ab2eaed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/content/docs/agent/config/cli-flags.mdx
View File

@ -423,13 +423,15 @@ information.
## Log Options ## Log Options
- `-log-file` ((#\_log_file)) - writes all the Consul agent log messages - `-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 to a file at the path indicated by this flag. The filename defaults to `consul.log`.
is appended to the file name. If the value ends in a path separator, `consul-` 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` 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 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 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) [`-log-rotate-bytes`](#_log_rotate_bytes) and [`-log-rotate-duration`](#_log_rotate_duration)
for a fine-grained log rotation experience. 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 - `-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, bytes that should be written to a log before it needs to be rotated. Unless specified,