Skip to content

Commit 8d55a05

Browse files
authored
Add details on how to enable trace logging to bug report template (#117)
* Add details on how to enable trace logging to bug report template * Add a note about sensitive information in trace logs
1 parent dc71ece commit 8d55a05

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,20 @@ I tried this code:
5454
I expected to see this happen: <explanation>
5555
5656
Instead, this happened: <explanation>
57+
58+
It's also helpful to enable trace logging and include the
59+
log messages as these will show the actual HTTP requests and
60+
responses. You can enable this by initializing `tracing-subscriber`
61+
if you haven't already (e.g., `tracing_subscriber::fmt::init();`),
62+
and then setting the environment variable `RUST_LOG` before
63+
running your program, as follows:
64+
65+
`RUST_LOG='smithy_http_tower::dispatch=trace,smithy_http::middleware=trace'`
66+
67+
For example:
68+
69+
`RUST_LOG='smithy_http_tower::dispatch=trace,smithy_http::middleware=trace' cargo run`
70+
71+
The SDK redacts sensitive information such as auth headers in these trace logs,
72+
but please look through them before posting just to be sure.
5773
-->

0 commit comments

Comments
 (0)