From 8c63221745e9eb5e818cdacb460315345a877859 Mon Sep 17 00:00:00 2001 From: Diego Barreiro Date: Fri, 4 Aug 2023 13:49:12 +0200 Subject: [PATCH] Include Tracer environment variables Clarifies Tracer's documentation page by including its related environment variables. --- docs/core/tracer.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/core/tracer.md b/docs/core/tracer.md index 413434718db..0e4d18dae47 100644 --- a/docs/core/tracer.md +++ b/docs/core/tracer.md @@ -21,6 +21,16 @@ Tracer is an opinionated thin wrapper for [AWS X-Ray Python SDK](https://github. !!! note "Tracer relies on AWS X-Ray SDK over [OpenTelememetry Distro (ADOT)](https://aws-otel.github.io/docs/getting-started/lambda){target="_blank" rel="nofollow"} for optimal cold start (lower latency)." +Tracer uses the following environment variables to globally set its configuration: + +| Setting | Description | Environment variable | Default | +|-----------------------|--------------------------------------------------|--------------------------------------|---------| +| **Disable Tracing** | Explicitly disables all tracing. | `POWERTOOLS_TRACE_DISABLED` | `false` | +| **Response Capture** | Captures Lambda or method return as metadata. | `POWERTOOLS_TRACER_CAPTURE_RESPONSE` | `true` | +| **Exception Capture** | Captures Lambda or method exception as metadata. | `POWERTOOLS_TRACER_CAPTURE_ERROR` | `true` | + +Both `POWERTOOLS_TRACER_CAPTURE_RESPONSE` and `POWERTOOLS_TRACER_CAPTURE_ERROR` can be set on a per-method basis (see [Advanced](#advanced)), overriding the environment variable value. + ### Install !!! info "This is not necessary if you're installing Powertools for AWS Lambda (Python) via [Lambda Layer/SAR](../index.md#lambda-layer){target="_blank"}"