Skip to content

Commit

Permalink
Add link to CSI driver LOGGING.md to Mountpoint LOGGING.md (#925)
Browse files Browse the repository at this point in the history
We added a new logging document in the CSI Driver project, which helps support locating the logs on the underlying host. This isn't visible from the Mountpoint repository including troubleshooting guides, so let's link it from MP's logging documentation.

Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
  • Loading branch information
dannycjones authored Jul 1, 2024
1 parent cc8d309 commit 08aa2b8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/LOGGING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ On other systems, syslog entries are likely written to a file such as `/var/log/

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).

> [!NOTE]
> If you are using [Mountpoint for Amazon S3 CSI Driver](https://github.com/awslabs/mountpoint-s3-csi-driver/), logs will be written to the syslog on the underlying node.
> Follow [Mountpoint CSI Driver's LOGGING.md guide](https://github.com/awslabs/mountpoint-s3-csi-driver/blob/main/docs/LOGGING.md) to learn about how to get logs for both Mountpoint and the driver itself.
## 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 with `mount-s3`.
Expand Down

0 comments on commit 08aa2b8

Please sign in to comment.