Update log file docs (#2141)
## 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
This commit is contained in:
parent
01d8d085e8
commit
928913f6b0
2
.github/ISSUE_TEMPLATE/BUG-REPORT.yaml
vendored
2
.github/ISSUE_TEMPLATE/BUG-REPORT.yaml
vendored
@ -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
|
||||
|
||||
@ -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">
|
||||
|
||||
Log file location can be overridden by setting the `--log-file` flag.
|
||||
```powershell
|
||||
%LocalAppData%\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="unix" label="Linux">
|
||||
|
||||
```bash
|
||||
$HOME/.cache/corso/logs/<timestamp>.log
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos" label="macOS">
|
||||
|
||||
```bash
|
||||
$HOME/Library/Logs/corso/logs/<timestamp>.log
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user