Skip to content

Commit 0ce83d1

Browse files
committed
Added the environment variable for logging the service name automatically.
1 parent e69b1c7 commit 0ce83d1

File tree

6 files changed

+15
-17
lines changed

6 files changed

+15
-17
lines changed

example/template.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Resources:
2020
MemorySize: 512
2121
Environment: # More info about Env Vars: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object
2222
Variables:
23-
POWERTOOLS_SERVICE_NAME: SAILING
23+
POWERTOOLS_SERVICE_NAME: "Payment Service"
2424
Tracing: Active
2525
Events:
2626
HelloWorld:

pom.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -188,11 +188,6 @@
188188
<groupId>org.apache.maven.plugins</groupId>
189189
<artifactId>maven-surefire-plugin</artifactId>
190190
<version>2.22.2</version>
191-
<configuration>
192-
<environmentVariables>
193-
<POWERTOOLS_SERVICE_NAME>testService</POWERTOOLS_SERVICE_NAME>
194-
</environmentVariables>
195-
</configuration>
196191
</plugin>
197192
<plugin>
198193
<groupId>org.jacoco</groupId>

src/main/java/software/amazon/lambda/internal/LambdaHandlerProcessor.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
import org.aspectj.lang.ProceedingJoinPoint;
1010

1111
public final class LambdaHandlerProcessor {
12-
public static String SERVICE_NAME = System.getenv("POWERTOOLS_SERVICE_NAME");
12+
public static String SERVICE_NAME = null != System.getenv("POWERTOOLS_SERVICE_NAME")
13+
? System.getenv("POWERTOOLS_SERVICE_NAME") : "service_undefined";
1314
public static Boolean IS_COLD_START = null;
1415

1516
public static boolean isHandlerMethod(ProceedingJoinPoint pjp) {

src/main/java/software/amazon/lambda/tracing/PowerTracer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
import com.amazonaws.xray.entities.Entity;
77
import com.amazonaws.xray.entities.Subsegment;
88

9+
import static software.amazon.lambda.internal.LambdaHandlerProcessor.SERVICE_NAME;
10+
911
public final class PowerTracer {
10-
public static final String SERVICE_NAME = null != System.getenv("POWERTOOLS_SERVICE_NAME")
11-
? System.getenv("POWERTOOLS_SERVICE_NAME") : "service_undefined";
1212

1313
public static void putAnnotation(String key, String value) {
1414
AWSXRay.getCurrentSubsegmentOptional()

src/main/java/software/amazon/lambda/tracing/internal/LambdaTracingAspect.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
import org.aspectj.lang.annotation.Around;
88
import org.aspectj.lang.annotation.Aspect;
99
import org.aspectj.lang.annotation.Pointcut;
10+
import software.amazon.lambda.internal.LambdaHandlerProcessor;
1011
import software.amazon.lambda.tracing.PowerToolTracing;
11-
import software.amazon.lambda.tracing.PowerTracer;
1212

1313
import static software.amazon.lambda.internal.LambdaHandlerProcessor.IS_COLD_START;
1414
import static software.amazon.lambda.internal.LambdaHandlerProcessor.isHandlerMethod;
@@ -59,7 +59,7 @@ public Object around(ProceedingJoinPoint pjp,
5959
}
6060

6161
private String namespace(PowerToolTracing powerToolsTracing) {
62-
return powerToolsTracing.namespace().isEmpty() ? PowerTracer.SERVICE_NAME : powerToolsTracing.namespace();
62+
return powerToolsTracing.namespace().isEmpty() ? LambdaHandlerProcessor.SERVICE_NAME : powerToolsTracing.namespace();
6363
}
6464

6565
private boolean placedOnHandlerMethod(ProceedingJoinPoint pjp) {

src/test/java/software/amazon/lambda/logging/internal/LambdaLoggingAspectTest.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929

3030
class LambdaLoggingAspectTest {
3131

32+
private static final int EXPECTED_CONTEXT_SIZE = 6;
3233
private RequestStreamHandler requestStreamHandler;
3334
private RequestHandler<Object, Object> requestHandler;
3435

@@ -50,7 +51,7 @@ void shouldSetLambdaContextWhenEnabled() {
5051
requestHandler.handleRequest(new Object(), context);
5152

5253
assertThat(ThreadContext.getImmutableContext())
53-
.hasSize(6)
54+
.hasSize(EXPECTED_CONTEXT_SIZE)
5455
.containsEntry(DefaultLambdaFields.FUNCTION_ARN.getName(), "testArn")
5556
.containsEntry(DefaultLambdaFields.FUNCTION_MEMORY_SIZE.getName(), "10")
5657
.containsEntry(DefaultLambdaFields.FUNCTION_VERSION.getName(), "1")
@@ -66,7 +67,7 @@ void shouldSetLambdaContextForStreamHandlerWhenEnabled() throws IOException {
6667
requestStreamHandler.handleRequest(new ByteArrayInputStream(new byte[]{}), new ByteArrayOutputStream(), context);
6768

6869
assertThat(ThreadContext.getImmutableContext())
69-
.hasSize(6)
70+
.hasSize(EXPECTED_CONTEXT_SIZE)
7071
.containsEntry(DefaultLambdaFields.FUNCTION_ARN.getName(), "testArn")
7172
.containsEntry(DefaultLambdaFields.FUNCTION_MEMORY_SIZE.getName(), "10")
7273
.containsEntry(DefaultLambdaFields.FUNCTION_VERSION.getName(), "1")
@@ -86,7 +87,7 @@ void shouldSetColdStartFlag() throws IOException {
8687
requestStreamHandler.handleRequest(new ByteArrayInputStream(new byte[]{}), new ByteArrayOutputStream(), context);
8788

8889
assertThat(ThreadContext.getImmutableContext())
89-
.hasSize(6)
90+
.hasSize(EXPECTED_CONTEXT_SIZE)
9091
.containsEntry("coldStart", "false");
9192
}
9293

@@ -127,7 +128,7 @@ void shouldLogEventForHandler() {
127128
requestHandler.handleRequest(new Object(), context);
128129

129130
assertThat(ThreadContext.getImmutableContext())
130-
.hasSize(6);
131+
.hasSize(EXPECTED_CONTEXT_SIZE);
131132
}
132133

133134
@Test
@@ -144,15 +145,16 @@ void shouldLogEventForStreamAndLambdaStreamIsValid() throws IOException {
144145
.isEqualTo("{\"test\":\"payload\"}");
145146

146147
assertThat(ThreadContext.getImmutableContext())
147-
.hasSize(6);
148+
.hasSize(EXPECTED_CONTEXT_SIZE);
148149
}
149150

150151
@Test
151152
void shouldLogServiceNameWhenEnvVarSet() {
153+
LambdaHandlerProcessor.SERVICE_NAME = "testService";
152154
requestHandler.handleRequest(new Object(), context);
153155

154156
assertThat(ThreadContext.getImmutableContext())
155-
.hasSize(6)
157+
.hasSize(EXPECTED_CONTEXT_SIZE)
156158
.containsEntry("service", "testService");
157159
}
158160

0 commit comments

Comments
 (0)