Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Commit

Permalink
Update log file docs (#2141)
Browse files Browse the repository at this point in the history
## Description

- Updates the log file docs to use OS tabs
- Fixes Windows forward vs. backslash in paths
- Updates the GitHub issue template

## Does this PR need a docs update or release note?

- [x] ⛔ No 

## Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
  • Loading branch information
ntolia authored Jan 13, 2023
1 parent 01d8d08 commit 928913f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG-REPORT.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ body:
id: logs
attributes:
label: Relevant log output
description: Please run Corso with `--log-level debug`.
description: Please run Corso with `--log-level debug` and attach the log file.
placeholder: This will be automatically formatted, so no need for backticks.
render: shell
31 changes: 23 additions & 8 deletions website/docs/setup/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,29 @@ directory within the container.
## Log Files
The location of log files varies by operating system:
The default location of Corso's log file is shown below but the location can be overridden by using the `--log-file` flag.
You can also use `stdout` or `stderr` as the `--log-file` location to redirect the logs to "stdout" and "stderr" respectively.
* On Linux - `~/.cache/corso/logs/<timestamp>.log`
* On macOS - `~/Library/Logs/corso/logs/<timestamp>.log`
* On Windows - `%LocalAppData%\corso/logs/<timestamp>.log`
<Tabs groupId="os">
<TabItem value="win" label="Windows">
```powershell
%LocalAppData%\corso\logs\<timestamp>.log
```
Log file location can be overridden by setting the `--log-file` flag.
</TabItem>
<TabItem value="unix" label="Linux">
```bash
$HOME/.cache/corso/logs/<timestamp>.log
```
:::info
You can use `stdout` or `stderr` as the `--log-file` location to redirect the logs to "stdout" and "stderr" respectively.
:::
</TabItem>
<TabItem value="macos" label="macOS">
```bash
$HOME/Library/Logs/corso/logs/<timestamp>.log
```
</TabItem>
</Tabs>

0 comments on commit 928913f

Please sign in to comment.