From 4776c62673938a5ae92e2a63a27408b7dc93e5a2 Mon Sep 17 00:00:00 2001 From: heitorlessa Date: Fri, 2 Jul 2021 13:28:43 +0200 Subject: [PATCH] docs(tracer): additional scenario when to disable auto-capture Signed-off-by: heitorlessa --- docs/core/tracer.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/core/tracer.md b/docs/core/tracer.md index fb99c6c702b..b9cd86862f5 100644 --- a/docs/core/tracer.md +++ b/docs/core/tracer.md @@ -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"