Update documentation around log_spans

This commit is contained in:
asonix 2023-12-12 17:55:40 -06:00
parent c93f9fe07e
commit ed8fce817b
2 changed files with 17 additions and 0 deletions

View file

@ -74,6 +74,11 @@ format = 'normal'
# Follows the same format as RUST_LOG # Follows the same format as RUST_LOG
targets = 'warn,tracing_actix_web=info,actix_server=info,actix_web=info' targets = 'warn,tracing_actix_web=info,actix_server=info,actix_web=info'
## Optional: whether pict-rs should log the new & close span events for tracing spans to stdout
# environment variable: PICTRS__TRACING__LOGGING__LOG_SPANS
# default: false
log_spans = false
## Console configuration ## Console configuration
[tracing.console] [tracing.console]

View file

@ -343,6 +343,18 @@ pict-rs 0.5 no longer logs the opening and closing of tracing spans. This means
be mostly empty aside from the occasional warning or error. Errors should still provide ample debug be mostly empty aside from the occasional warning or error. Errors should still provide ample debug
information, so the decrease in verbosity should not negatively affect debugging of the program. information, so the decrease in verbosity should not negatively affect debugging of the program.
These spans can be re-enabled by setting a configuration option or passing a commandline flag.
```toml
[tracing.logging]
log_spans = true
```
```bash
PICTRS__TRACING__LOGGING__LOG_SPANS=true
```
```bash
pict-rs --log-spans
```
### Quality Configuration ### Quality Configuration