Skip to content

Commit ce46067

Browse files
committed
Add information about replay sandboxing
1 parent 199256f commit ce46067

3 files changed

Lines changed: 11 additions & 4 deletions

File tree

.devcontainer/setup.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ echo ""
4242
echo "✅ Setup complete!"
4343
echo ""
4444
echo "📚 Quick Start Guide:"
45-
echo " 1. Run pre-recorded tests: tusk run"
46-
echo " 2. See Tusk CLI commands: tusk --help"
45+
echo " 1. Run pre-recorded tests: tusk drift run"
46+
echo " 2. See Tusk CLI commands: tusk drift --help"
4747
echo " 3. Start server in record mode: TUSK_DRIFT_MODE=record python server.py"
4848
echo " 4. Check out buggy branch: git checkout buggy-branch"
4949
echo ""

.tusk/config.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ recording:
2020
export_spans: false # Export spans to cloud
2121
enable_env_var_recording: false
2222

23+
replay:
24+
sandbox:
25+
# Disabled for this demo because Codespaces/devcontainers may block the Linux replay sandbox.
26+
# Your own app still defaults to strict sandboxing unless you override it.
27+
mode: off
28+
2329
tusk_api:
2430
url: https://use-tusk-dev.uc.r.appspot.com
2531
# Only recording traces locally, API url not needed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,9 @@ The CLI replays recorded traces against your service:
185185
- `tusk drift list` - List available traces
186186
- `tusk drift run` - Replay local traces
187187

188+
> [!NOTE]
189+
> During replay, Tusk normally starts your service in a [Fence](https://github.com/Use-Tusk/fence) sandbox so tests use recorded responses instead of live outbound calls. This demo sets `replay.sandbox.mode: off` in `.tusk/config.yaml` because GitHub Codespaces/devcontainers may block the Linux sandbox; your own app still defaults to strict sandboxing unless you override it.
190+
188191
### 3. **Tusk Cloud** (Optional)
189192

190193
Tusk Cloud adds automated trace curation and failure analysis on top of the open-source CLI/SDK.
@@ -307,6 +310,4 @@ Questions? Reach out:
307310
- 🐛 Issues: [GitHub Issues](https://github.com/Use-Tusk/drift-python-demo/issues)
308311
- 𝕏 Twitter: [@usetusk](https://twitter.com/usetusk)
309312

310-
---
311-
312313
**Ready to catch bugs before production?** [Get started with Tusk Drift →](https://github.com/Use-Tusk/drift-python-sdk)

0 commit comments

Comments
 (0)