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

Improve clarity of LOGGING.md for --log-directory argument #558

Merged
merged 2 commits into from
Oct 18, 2023
Merged

Improve clarity of LOGGING.md for --log-directory argument #558

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e75e24d
Improve clarity of LOGGING.md for `--log-directory` argument
dannycjones Oct 17, 2023
14c3abe
Add extra mention of `mount-s3` for arguments after we mention `journ…
dannycjones Oct 17, 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
7 changes: 5 additions & 2 deletions doc/LOGGING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ By default, Mountpoint for Amazon S3 emits high-severity log information to [sys

On other systems, syslog entries are likely written to a file such as `/var/log/syslog`.

When running in foreground mode (the `-f, --foreground` command-line argument), Mountpoint will emit logs to stdout in addition to syslog or any configured log directory (see below).
When running `mount-s3` in foreground mode (the `-f, --foreground` command-line argument), Mountpoint will emit logs to stdout in addition to syslog or any configured log directory (see below).

## Logging to a file

You can direct logs to a file instead of syslog by providing a destination directory using the `-l, --log-directory` command-line argument.
You can direct logs to a file instead of syslog by providing a destination directory using the `-l, --log-directory` command-line argument with `mount-s3`.

mount-s3 <BUCKET> <MOUNT_PATH> --log-directory <LOG_DIRECTORY>

The directory will be created if it doesn't exist.
A new log file will be created for each execution of `mount-s3`.
Both the directory and log files are created with read/write access for the process owner and read access for the process owner's group.
Expand Down
Loading