From ed8fce817b3bb83e810e5d154120eaf7738ad3b3 Mon Sep 17 00:00:00 2001
From: asonix <asonix@asonix.dog>
Date: Tue, 12 Dec 2023 17:55:40 -0600
Subject: [PATCH] Update documentation around log_spans

---
 pict-rs.toml      |  5 +++++
 releases/0.5.0.md | 12 ++++++++++++
 2 files changed, 17 insertions(+)

diff --git a/pict-rs.toml b/pict-rs.toml
index e5a72cd..6130786 100644
--- a/pict-rs.toml
+++ b/pict-rs.toml
@@ -74,6 +74,11 @@ format = 'normal'
 # Follows the same format as RUST_LOG
 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
 [tracing.console]
diff --git a/releases/0.5.0.md b/releases/0.5.0.md
index f9d4193..80d95fd 100644
--- a/releases/0.5.0.md
+++ b/releases/0.5.0.md
@@ -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
 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