Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of Fix docs for log file name changes into release/1.16.x #18977

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Backport of Fix docs for log file name changes into release/1.16.x #18977

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba0e176
backport of commit 541633ceef72cfe1c4b97b0f33843a98c973dcd1
absolutelightning Sep 20, 2023
eee41f7
Fix docs for log file name changes (#18913)
absolutelightning Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions website/content/docs/agent/config/cli-flags.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down