Initial tracing #15
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package software.aws.lambda.internal; | ||
|
|
||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
|
|
||
| import com.amazonaws.services.lambda.runtime.Context; | ||
| import com.amazonaws.services.lambda.runtime.RequestHandler; | ||
| import com.amazonaws.services.lambda.runtime.RequestStreamHandler; | ||
| import org.aspectj.lang.ProceedingJoinPoint; | ||
|
|
||
| public final class LambdaHandlerProcessor { | ||
| public static boolean isHandlerMethod(ProceedingJoinPoint pjp) { | ||
| return "handleRequest".equals(pjp.getSignature().getName()); | ||
| } | ||
|
|
||
| public static boolean placedOnRequestHandler(ProceedingJoinPoint pjp) { | ||
| return RequestHandler.class.isAssignableFrom(pjp.getSignature().getDeclaringType()) | ||
| && pjp.getArgs().length == 2 | ||
| && pjp.getArgs()[1] instanceof Context; | ||
| } | ||
|
|
||
| public static boolean placedOnStreamHandler(ProceedingJoinPoint pjp) { | ||
| return RequestStreamHandler.class.isAssignableFrom(pjp.getSignature().getDeclaringType()) | ||
| && pjp.getArgs().length == 3 | ||
| && pjp.getArgs()[0] instanceof InputStream | ||
| && pjp.getArgs()[1] instanceof OutputStream | ||
| && pjp.getArgs()[2] instanceof Context; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package software.aws.lambda.tracing; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Target(ElementType.METHOD) | ||
| public @interface PowerToolTracing { | ||
| String namespace() default ""; | ||
| boolean captureResponse() default true; | ||
| boolean captureError() default true; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| package software.aws.lambda.tracing; | ||
|
|
||
| import java.util.function.Consumer; | ||
|
|
||
| import com.amazonaws.xray.AWSXRay; | ||
| import com.amazonaws.xray.entities.Entity; | ||
| import com.amazonaws.xray.entities.Subsegment; | ||
|
|
||
| public final class PowerTracer { | ||
|
There was a problem hiding this comment. Helper utils for setting annotation and metadata on current segment There was a problem hiding this comment. Can we directly do a good Javadoc documentation? There was a problem hiding this comment. I belive its too early to spend effort on writing java docs. IMO we can delay it a bit until we have a but more structure |
||
| public static final String SERVICE_NAME = null != System.getenv("POWERTOOLS_SERVICE_NAME") | ||
|
There was a problem hiding this comment. In the python impl this is "service_undefined" by default. Might be worth matching their project for consistency. There was a problem hiding this comment. Xray recorder lib by default uses: private static final String DEFAULT_METADATA_NAMESPACE = "default"; But i can update it to match with that of powertools. |
||
| ? System.getenv("POWERTOOLS_SERVICE_NAME") : "service_undefined"; | ||
|
|
||
| public static void putAnnotation(String key, String value) { | ||
| AWSXRay.getCurrentSubsegmentOptional() | ||
| .ifPresent(segment -> segment.putAnnotation(key, value)); | ||
| } | ||
|
|
||
| public static void putMetadata(String key, Object value) { | ||
| String namespace = AWSXRay.getCurrentSubsegmentOptional() | ||
| .map(Subsegment::getNamespace).orElse(SERVICE_NAME); | ||
|
|
||
| putMetadata(namespace, key, value); | ||
| } | ||
|
|
||
| public static void putMetadata(String namespace, String key, Object value) { | ||
| AWSXRay.getCurrentSubsegmentOptional() | ||
| .ifPresent(segment -> segment.putMetadata(namespace, key, value)); | ||
| } | ||
|
|
||
| public static void withEntitySubsegment(String name, Entity entity, Consumer<Subsegment> subsegment) { | ||
| AWSXRay.setTraceEntity(entity); | ||
| withSubsegment(name, subsegment); | ||
| } | ||
|
|
||
| public static void withSubsegment(String name, Consumer<Subsegment> subsegment) { | ||
| Subsegment segment = AWSXRay.beginSubsegment("## " + name); | ||
msailes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| try { | ||
| subsegment.accept(segment); | ||
| } finally { | ||
| AWSXRay.endSubsegment(); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| package software.aws.lambda.tracing.internal; | ||
|
|
||
| import com.amazonaws.xray.AWSXRay; | ||
| import com.amazonaws.xray.entities.Subsegment; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import org.aspectj.lang.ProceedingJoinPoint; | ||
| import org.aspectj.lang.annotation.Around; | ||
| import org.aspectj.lang.annotation.Aspect; | ||
| import org.aspectj.lang.annotation.Pointcut; | ||
| import software.aws.lambda.tracing.PowerToolTracing; | ||
|
|
||
| import static software.aws.lambda.internal.LambdaHandlerProcessor.isHandlerMethod; | ||
| import static software.aws.lambda.internal.LambdaHandlerProcessor.placedOnRequestHandler; | ||
| import static software.aws.lambda.internal.LambdaHandlerProcessor.placedOnStreamHandler; | ||
| import static software.aws.lambda.tracing.PowerTracer.SERVICE_NAME; | ||
|
|
||
| @Aspect | ||
| public final class LambdaTracingAspect { | ||
| static Boolean IS_COLD_START = null; | ||
|
There was a problem hiding this comment. Can we have the cold start logic in a single place? |
||
| private static final ObjectMapper mapper = new ObjectMapper(); | ||
|
|
||
| @Pointcut("@annotation(powerToolsTracing)") | ||
| public void callAt(PowerToolTracing powerToolsTracing) { | ||
| } | ||
|
|
||
| @Around(value = "callAt(powerToolsTracing) && execution(@PowerToolTracing * *.*(..))", argNames = "pjp,powerToolsTracing") | ||
| public Object around(ProceedingJoinPoint pjp, | ||
| PowerToolTracing powerToolsTracing) throws Throwable { | ||
| Object[] proceedArgs = pjp.getArgs(); | ||
| Subsegment segment; | ||
|
|
||
| segment = AWSXRay.beginSubsegment("## " + pjp.getSignature().getName()); | ||
| segment.setNamespace(namespace(powerToolsTracing)); | ||
|
|
||
| boolean placedOnHandlerMethod = placedOnHandlerMethod(pjp); | ||
|
|
||
| if (placedOnHandlerMethod) { | ||
| segment.putAnnotation("ColdStart", IS_COLD_START == null); | ||
| } | ||
|
|
||
| IS_COLD_START = false; | ||
|
|
||
| try { | ||
| Object methodReturn = pjp.proceed(proceedArgs); | ||
| if (powerToolsTracing.captureResponse()) { | ||
| segment.putMetadata(namespace(powerToolsTracing), pjp.getSignature().getName() + " response", response(pjp, methodReturn)); | ||
| } | ||
| return methodReturn; | ||
| } catch (Exception e) { | ||
| if (powerToolsTracing.captureError()) { | ||
| segment.putMetadata(namespace(powerToolsTracing), pjp.getSignature().getName() + " error", e); | ||
| } | ||
| throw e; | ||
| } finally { | ||
| AWSXRay.endSubsegment(); | ||
| } | ||
| } | ||
|
|
||
| private Object response(ProceedingJoinPoint pjp, Object methodReturn) { | ||
| // TODO should we try to parse output stream? or just not support it? | ||
| if (placedOnStreamHandler(pjp)) { | ||
|
|
||
| } | ||
|
|
||
| return methodReturn; | ||
| } | ||
|
|
||
| private String namespace(PowerToolTracing powerToolsTracing) { | ||
| return powerToolsTracing.namespace().isEmpty() ? SERVICE_NAME : powerToolsTracing.namespace(); | ||
| } | ||
|
|
||
| private boolean placedOnHandlerMethod(ProceedingJoinPoint pjp) { | ||
|
There was a problem hiding this comment. We can enrich this further like its done in logging part, but we can do that once we agree on approach here. |
||
| return isHandlerMethod(pjp) | ||
| && (placedOnRequestHandler(pjp) || placedOnStreamHandler(pjp)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.