Skip to content

Commit

Permalink
Add troubleshooting doc (#14565)
Browse files Browse the repository at this point in the history
Since I'm often re-explaining how to enable tracing, I thought it would
be useful to have the instructions written in a GitHub doc. We can also
use this doc to add other user-facing troubleshooting tips.
###### Microsoft Reviewers: [Open in
CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/14565)
  • Loading branch information
anthony-c-martin authored Jul 15, 2024
1 parent 0312d15 commit 9dc6238
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Tracing
To collect troubleshooting information, it can be useful to enable detailed tracing. To do this, run one of the following commands in your console window before invoking Bicep:

1. (Mac/Linux) Run the following:
```sh
export BICEP_TRACING_ENABLED=true
```
1. (Windows) Run the following in a PowerShell window:
```powershell
$env:BICEP_TRACING_ENABLED = $true
```

0 comments on commit 9dc6238

Please sign in to comment.