Skip to content

docs(tracer): additional scenario when to disable auto-capture #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 2, 2021
Merged

docs(tracer): additional scenario when to disable auto-capture #499

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs(tracer): additional scenario when to disable auto-capture 
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
  • Loading branch information
@heitorlessa
heitorlessa committed Jul 2, 2021
commit 4776c62673938a5ae92e2a63a27408b7dc93e5a2
3 changes: 2 additions & 1 deletion docs/core/tracer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,11 @@ tracer = Tracer(patch_modules=modules_to_be_patched)

Use **`capture_response=False`** parameter in both `capture_lambda_handler` and `capture_method` decorators to instruct Tracer **not** to serialize function responses as metadata.

!!! info "This is commonly useful in two scenarios"
!!! info "This is commonly useful in three scenarios"

1. You might **return sensitive** information you don't want it to be added to your traces
2. You might manipulate **streaming objects that can be read only once**; this prevents subsequent calls from being empty
3. You might return **more than 64K** of data _e.g., `message too long` error_

=== "sensitive_data_scenario.py"
```python hl_lines="3 7"
Expand Down