Docs: content capture + set_correlation API#26
Merged
deborahjacob-botanu merged 4 commits intomainfrom Apr 24, 2026
Merged
Conversation
Replace @botanu_workflow / run_botanu / @botanu_outcome with botanu.event() (context manager + async CM + decorator) and botanu.step() for multi-phase events. event() lazy-calls enable() so customers don't need a separate init step. - Remove lean mode (full baggage is only mode; drop BAGGAGE_KEYS_LEAN, lean_mode param, propagation_mode field, BOTANU_PROPAGATION_MODE env) - Remove emit_outcome(status=...) positional arg (diagnostic fields only) - Drop ~440 LOC of legacy decorators + dead outcome.status checks - Add lazy _ensure_enabled() on first event() call - Rewrite all 20 SDK docs (Langfuse-style, each example self-contained) - Fix to_baggage_dict docs: 5 always + 7 conditional keys - Drop stale api_key field claim from BotanuConfig docs 417 tests pass, ruff clean.
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 31556002 | Triggered | Bearer Token | 9ebc4c6 | tests/unit/test_pii.py | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
- README: rewrite quickstart around botanu.event(), drop enable() mention - CHANGELOG: add Unreleased "Breaking" section for the event/step pivot and lean-mode removal; rewrite "Added" around the new API - RELEASE: fix smoke-test script to use botanu.event() - api/configuration.md: drop api_key field claim, fix to_baggage_dict description (5 always + 7 conditional, not "always 7") - api/event.md: drop auto-enable note - getting-started/configuration.md: drop enable() code examples, drop api_key field from BotanuConfig listing, drop "it calls enable()" note under zero-code init section - getting-started/quickstart.md: drop enable() mention - index.md: drop enable() mention - integration/auto-instrumentation.md: reframe around first event() call - integration/collector.md: drop enable() code example - integration/existing-otel.md: reframe the whole page around "on first botanu.event() call" instead of "when you call enable()"; drop brownfield/greenfield terminology for customer-facing copy - patterns/anti-patterns.md: remove "Calling enable() repeatedly" anti-pattern section - tracking/content-capture.md: drop enable() code example
Signed-off-by: deborahjacob-botanu <deborah@botanu.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Type of change
Testing
pytest)ruff check)mypy)Checklist
git commit -s) per the DCO