From 5de1c9b5f768398dd94837df09d0649ac0b59ad7 Mon Sep 17 00:00:00 2001 From: Pankaj Agrawal Date: Tue, 12 Jan 2021 18:22:55 +0100 Subject: [PATCH] chore: Consistent env variable names for tracing --- docs/content/core/tracing.mdx | 8 ++++---- docs/content/index.mdx | 4 ++-- .../lambda/powertools/tracing/CaptureMode.java | 14 +++++++------- .../tracing/internal/LambdaTracingAspect.java | 10 +++++----- .../internal/LambdaTracingAspectTest.java | 16 ++++++++-------- 5 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/content/core/tracing.mdx b/docs/content/core/tracing.mdx index 0f0e3d03e..390844046 100644 --- a/docs/content/core/tracing.mdx +++ b/docs/content/core/tracing.mdx @@ -73,14 +73,14 @@ public class App implements RequestHandler Returning sensitive information from your Lambda handler or functions, where Tracer is used?

You can disable annotation from capturing their responses and exception as tracing metadata with captureMode=DISABLED - or globally by setting environment variables TRACING_CAPTURE_RESPONSE and TRACING_CAPTURE_ERROR to false. + or globally by setting environment variables POWERTOOLS_TRACER_CAPTURE_RESPONSE and POWERTOOLS_TRACER_CAPTURE_ERROR to false.
```java:title=HandlerWithoutCapturingResponseOrError.java @@ -104,8 +104,8 @@ Resources: Tracing: Active Environment: Variables: - TRACING_CAPTURE_RESPONSE: false # highlight-line - TRACING_CAPTURE_ERROR: false # highlight-line + POWERTOOLS_TRACER_CAPTURE_RESPONSE: false # highlight-line + POWERTOOLS_TRACER_CAPTURE_ERROR: false # highlight-line ``` ### Annotations diff --git a/docs/content/index.mdx b/docs/content/index.mdx index 02f22e0d9..32faadfff 100644 --- a/docs/content/index.mdx +++ b/docs/content/index.mdx @@ -124,8 +124,8 @@ Environment variable | Description | Utility **POWERTOOLS_METRICS_NAMESPACE** | Sets namespace used for metrics | [Metrics](./core/metrics) **POWERTOOLS_LOGGER_SAMPLE_RATE** | Debug log sampling | [Logging](./core/logging) **LOG_LEVEL** | Sets logging level | [Logging](./core/logging) -**TRACING_CAPTURE_RESPONSE** | Enables/Disables tracing mode to capture method response | [Tracing](./core/tracing) -**TRACING_CAPTURE_ERROR** | Enables/Disables tracing mode to capture method error | [Tracing](./core/tracing) +**POWERTOOLS_TRACER_CAPTURE_RESPONSE** | Enables/Disables tracing mode to capture method response | [Tracing](./core/tracing) +**POWERTOOLS_TRACER_CAPTURE_ERROR** | Enables/Disables tracing mode to capture method error | [Tracing](./core/tracing) ## Tenets diff --git a/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/CaptureMode.java b/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/CaptureMode.java index e8408fb63..9fd09e8ee 100644 --- a/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/CaptureMode.java +++ b/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/CaptureMode.java @@ -3,29 +3,29 @@ public enum CaptureMode { /** * Enables annotation to capture only response. If this mode is explicitly overridden - * on {@link Tracing} annotation, it will override value of environment variable TRACING_CAPTURE_RESPONSE + * on {@link Tracing} annotation, it will override value of environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE */ RESPONSE, /** * Enabled annotation to capture only error from the method. If this mode is explicitly overridden - * on {@link Tracing} annotation, it will override value of environment variable TRACING_CAPTURE_ERROR + * on {@link Tracing} annotation, it will override value of environment variable POWERTOOLS_TRACER_CAPTURE_ERROR */ ERROR, /** * Enabled annotation to capture both response error from the method. If this mode is explicitly overridden - * on {@link Tracing} annotation, it will override value of environment variables TRACING_CAPTURE_RESPONSE - * and TRACING_CAPTURE_ERROR + * on {@link Tracing} annotation, it will override value of environment variables POWERTOOLS_TRACER_CAPTURE_RESPONSE + * and POWERTOOLS_TRACER_CAPTURE_ERROR */ RESPONSE_AND_ERROR, /** * Disables annotation to capture both response and error from the method. If this mode is explicitly overridden - * on {@link Tracing} annotation, it will override values of environment variable TRACING_CAPTURE_RESPONSE - * and TRACING_CAPTURE_ERROR + * on {@link Tracing} annotation, it will override values of environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE + * and POWERTOOLS_TRACER_CAPTURE_ERROR */ DISABLED, /** * Enables/Disables annotation to capture response and error from the method based on the value of - * environment variable TRACING_CAPTURE_RESPONSE and TRACING_CAPTURE_ERROR + * environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE and POWERTOOLS_TRACER_CAPTURE_ERROR */ ENVIRONMENT_VAR } diff --git a/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspect.java b/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspect.java index 0d552f2f2..e1d765a4a 100644 --- a/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspect.java +++ b/powertools-tracing/src/main/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspect.java @@ -78,7 +78,7 @@ public Object around(ProceedingJoinPoint pjp, private boolean captureResponse(Tracing powerToolsTracing) { switch (powerToolsTracing.captureMode()) { case ENVIRONMENT_VAR: - Boolean captureResponse = environmentVariable("TRACING_CAPTURE_RESPONSE"); + Boolean captureResponse = environmentVariable("POWERTOOLS_TRACER_CAPTURE_RESPONSE"); return null != captureResponse ? captureResponse : powerToolsTracing.captureResponse(); case RESPONSE: case RESPONSE_AND_ERROR: @@ -92,7 +92,7 @@ private boolean captureResponse(Tracing powerToolsTracing) { private boolean captureError(Tracing powerToolsTracing) { switch (powerToolsTracing.captureMode()) { case ENVIRONMENT_VAR: - Boolean captureError = environmentVariable("TRACING_CAPTURE_ERROR"); + Boolean captureError = environmentVariable("POWERTOOLS_TRACER_CAPTURE_ERROR"); return null != captureError ? captureError : powerToolsTracing.captureError(); case ERROR: case RESPONSE_AND_ERROR: @@ -117,8 +117,8 @@ private boolean placedOnHandlerMethod(ProceedingJoinPoint pjp) { && (placedOnRequestHandler(pjp) || placedOnStreamHandler(pjp)); } - private Boolean environmentVariable(String tracing_capture_response) { - return null != SystemWrapper.getenv(tracing_capture_response) - ? Boolean.valueOf(SystemWrapper.getenv(tracing_capture_response)) : null; + private Boolean environmentVariable(String POWERTOOLS_TRACER_CAPTURE_RESPONSE) { + return null != SystemWrapper.getenv(POWERTOOLS_TRACER_CAPTURE_RESPONSE) + ? Boolean.valueOf(SystemWrapper.getenv(POWERTOOLS_TRACER_CAPTURE_RESPONSE)) : null; } } diff --git a/powertools-tracing/src/test/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspectTest.java b/powertools-tracing/src/test/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspectTest.java index c500d684f..85577ac52 100644 --- a/powertools-tracing/src/test/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspectTest.java +++ b/powertools-tracing/src/test/java/software/amazon/lambda/powertools/tracing/internal/LambdaTracingAspectTest.java @@ -59,8 +59,8 @@ class LambdaTracingAspectTest { @BeforeAll static void beforeAll() { try (MockedStatic mocked = mockStatic(SystemWrapper.class)) { - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_RESPONSE")).thenReturn(null); - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_ERROR")).thenReturn(null); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_RESPONSE")).thenReturn(null); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_ERROR")).thenReturn(null); } } @@ -227,7 +227,7 @@ void shouldCaptureTracesWithNoMetadataDeprecated() { @Test void shouldNotCaptureTracesIfDisabledViaEnvironmentVariable() { try (MockedStatic mocked = mockStatic(SystemWrapper.class)) { - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_RESPONSE")).thenReturn("false"); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_RESPONSE")).thenReturn("false"); requestHandler.handleRequest(new Object(), context); @@ -247,7 +247,7 @@ void shouldNotCaptureTracesIfDisabledViaEnvironmentVariable() { @Test void shouldCaptureTracesIfExplicitlyEnabledAndEnvironmentVariableIsDisabled() { try (MockedStatic mocked = mockStatic(SystemWrapper.class)) { - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_RESPONSE")).thenReturn("false"); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_RESPONSE")).thenReturn("false"); requestHandler = new PowerTracerToolEnabledForResponse(); requestHandler.handleRequest(new Object(), context); @@ -269,8 +269,8 @@ void shouldCaptureTracesIfExplicitlyEnabledAndEnvironmentVariableIsDisabled() { @Test void shouldCaptureTracesIfExplicitlyEnabledBothAndEnvironmentVariableIsDisabled() { try (MockedStatic mocked = mockStatic(SystemWrapper.class)) { - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_RESPONSE")).thenReturn("false"); - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_ERROR")).thenReturn("false"); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_RESPONSE")).thenReturn("false"); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_ERROR")).thenReturn("false"); requestHandler = new PowerTracerToolEnabledExplicitlyForResponseAndError(); requestHandler.handleRequest(new Object(), context); @@ -292,7 +292,7 @@ void shouldCaptureTracesIfExplicitlyEnabledBothAndEnvironmentVariableIsDisabled( @Test void shouldNotCaptureTracesWithExceptionMetaDataIfDisabledViaEnvironmentVariable() { try (MockedStatic mocked = mockStatic(SystemWrapper.class)) { - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_ERROR")).thenReturn("false"); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_ERROR")).thenReturn("false"); requestHandler = new PowerTracerToolEnabledWithException(); catchThrowable(() -> requestHandler.handleRequest(new Object(), context)); @@ -313,7 +313,7 @@ void shouldNotCaptureTracesWithExceptionMetaDataIfDisabledViaEnvironmentVariable @Test void shouldCaptureTracesWithExceptionMetaDataEnabledExplicitlyAndEnvironmentVariableDisabled() { try (MockedStatic mocked = mockStatic(SystemWrapper.class)) { - mocked.when(() -> SystemWrapper.getenv("TRACING_CAPTURE_ERROR")).thenReturn("false"); + mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_TRACER_CAPTURE_ERROR")).thenReturn("false"); requestHandler = new PowerTracerToolEnabledForError();