Profiler updates (#78)

* Profiler updates

Moved profiler to 'experimental' folder
Added AWS_LAMBDA_ prefix to env vars
Updated README.md

* fix: IAM permissions, wrapper, port communication and integration test

---------

Co-authored-by: Maxime David <[email protected]>

Author: jtuliani

.github/workflows/aws-lambda-java-profiler.yml

@@ -39,27 +39,27 @@ jobs:
           role-duration-seconds: 900
 
       - name: Build layer
-        working-directory: ./aws-lambda-java-profiler/extension
+        working-directory: ./experimental/aws-lambda-java-profiler/extension
         run: ./build_layer.sh
 
       - name: Publish layer
-        working-directory: ./aws-lambda-java-profiler
+        working-directory: ./experimental/aws-lambda-java-profiler
         run: ./integration_tests/publish_layer.sh
 
       - name: Create the bucket layer
-        working-directory: ./aws-lambda-java-profiler
+        working-directory: ./experimental/aws-lambda-java-profiler
         run: ./integration_tests/create_bucket.sh
 
       - name: Create Java function
-        working-directory: ./aws-lambda-java-profiler
+        working-directory: ./experimental/aws-lambda-java-profiler
         run: ./integration_tests/create_function.sh
 
       - name: Invoke Java function
-        working-directory: ./aws-lambda-java-profiler
+        working-directory: ./experimental/aws-lambda-java-profiler
         run: ./integration_tests/invoke_function.sh
 
       - name: Download from s3
-        working-directory: ./aws-lambda-java-profiler
+        working-directory: ./experimental/aws-lambda-java-profiler
         run: ./integration_tests/download_from_s3.sh
 
       - name: Upload profiles
@@ -70,5 +70,5 @@ jobs:
 
       - name: cleanup
         if: always()
-        working-directory: ./aws-lambda-java-profiler
+        working-directory: ./experimental/aws-lambda-java-profiler
         run: ./integration_tests/cleanup.sh

.gitignore

@@ -30,6 +30,8 @@ dependency-reduced-pom.xml
 aws-lambda-java-runtime-interface-client/pom.xml.versionsBackup
 
 # profiler
-aws-lambda-java-profiler/integration_tests/helloworld/build
-aws-lambda-java-profiler/extension/build/
+experimental/aws-lambda-java-profiler/integration_tests/helloworld/build
+experimental/aws-lambda-java-profiler/extension/build/
+experimental/aws-lambda-java-profiler/integration_tests/helloworld/bin
+!experimental/aws-lambda-java-profiler/extension/gradle/wrapper/*.jar
 /scratch/

aws-lambda-java-profiler/README.md

@@ -36,7 +36,7 @@ public InfraStack(final Construct scope, final String id, final StackProps props
                 .build();
 
         var environmentVariables = Map.of("JAVA_TOOL_OPTIONS", "-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints -javaagent:/opt/profiler.jar",
-                "PROFILER_RESULTS_BUCKET_NAME", resultsBucketName);
+                "AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME", resultsBucketName);
 
         var function = Function.Builder.create(this, "example-profiler-function")
                 .runtime(JAVA_21)

aws-lambda-java-profiler/.gitignore renamed to experimental/aws-lambda-java-profiler/.gitignore

@@ -23,7 +23,6 @@ public class ExtensionClient {
 			"            ]" +
 			"        }";
 	private static final String LAMBDA_EXTENSION_IDENTIFIER = "Lambda-Extension-Identifier";
-	private static final String LAMBDA_EXTENSION_FUNCTION_ERROR_TYPE = "Lambda-Extension-Function-Error-Type";
 	private static final HttpClient client = HttpClient.newBuilder().build();
 
 	public static String registerExtension() {

aws-lambda-java-profiler/.mvn/wrapper/maven-wrapper.properties renamed to experimental/aws-lambda-java-profiler/.mvn/wrapper/maven-wrapper.properties

@@ -15,6 +15,7 @@ public class ExtensionMain {
     private static boolean coldstart = true;
     private static final String REQUEST_ID = "requestId";
     private static final String EVENT_TYPE = "eventType";
+    private static final String INTERNAL_COMMUNICATION_PORT = System.getenv().getOrDefault("AWS_LAMBDA_PROFILER_COMMUNICATION_PORT", "1234");
     public static final String HEADER_NAME = "X-FileName";
 
     private static S3Manager s3Manager;
@@ -100,9 +101,10 @@ private static String extractInfo(String info, String jsonString) {
 
     private static void startProfiler() {
         try {
-           HttpRequest request = HttpRequest.newBuilder()
+            String url = String.format("http://localhost:%s/profiler/start", INTERNAL_COMMUNICATION_PORT);
+            HttpRequest request = HttpRequest.newBuilder()
                             .GET()
-                            .uri(URI.create("http://localhost:1234/profiler/start"))
+                            .uri(URI.create(url))
                             .build();
             HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
             if (response.statusCode() == 200) {
@@ -116,10 +118,11 @@ private static void startProfiler() {
 
     private static void stopProfiler(String fileNameSuffix) {
         try {
+            String url = String.format("http://localhost:%s/profiler/stop", INTERNAL_COMMUNICATION_PORT);
             HttpRequest request = HttpRequest.newBuilder()
                             .GET()
                             .setHeader(HEADER_NAME, fileNameSuffix)
-                            .uri(URI.create("http://localhost:1234/profiler/stop"))
+                            .uri(URI.create(url))
                             .build();
             HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
             if (response.statusCode() == 200) {

experimental/aws-lambda-java-profiler/README.md

@@ -8,7 +8,7 @@ public class Logger {
     private static final String PREFIX = "[PROFILER] ";
 
     private static boolean initializeDebugFlag() {
-        String envValue = System.getenv("PROFILER_DEBUG");
+        String envValue = System.getenv("AWS_LAMBDA_PROFILER_DEBUG");
         return "true".equalsIgnoreCase(envValue) || "1".equals(envValue);
     }
 

aws-lambda-java-profiler/docs/Arch_AWS-Lambda_64.svg renamed to experimental/aws-lambda-java-profiler/docs/Arch_AWS-Lambda_64.svg

@@ -17,11 +17,11 @@
 
 public class PreMain {    
 
-    private static final String DEFAULT_PROFILER_START_COMMAND = "start,event=wall,interval=1us";
-    private static final String DEFAULT_PROFILER_STOP_COMMAND = "stop,file=%s,include=*AWSLambda.main,include=start_thread";
-    private static final String PROFILER_START_COMMAND = System.getenv().getOrDefault("PROFILER_START_COMMAND", DEFAULT_PROFILER_START_COMMAND);
-    private static final String PROFILER_STOP_COMMAND = System.getenv().getOrDefault("PROFILER_STOP_COMMAND", DEFAULT_PROFILER_STOP_COMMAND);
-    private static final String INTERNAL_COMMUNICATION_PORT = System.getenv().getOrDefault("PROFILER_COMMUNICATION_PORT", "1234");
+    private static final String DEFAULT_AWS_LAMBDA_PROFILER_START_COMMAND = "start,event=wall,interval=1us";
+    private static final String DEFAULT_AWS_LAMBDA_PROFILER_STOP_COMMAND = "stop,file=%s,include=*AWSLambda.main,include=start_thread";
+    private static final String PROFILER_START_COMMAND = System.getenv().getOrDefault("AWS_LAMBDA_PROFILER_START_COMMAND", DEFAULT_AWS_LAMBDA_PROFILER_START_COMMAND);
+    private static final String PROFILER_STOP_COMMAND = System.getenv().getOrDefault("AWS_LAMBDA_PROFILER_STOP_COMMAND", DEFAULT_AWS_LAMBDA_PROFILER_STOP_COMMAND);
+    private static final String INTERNAL_COMMUNICATION_PORT = System.getenv().getOrDefault("AWS_LAMBDA_PROFILER_COMMUNICATION_PORT", "1234");
 
     public static void premain(String agentArgs, Instrumentation inst) {
         Logger.debug("premain is starting");

aws-lambda-java-profiler/docs/example-cold-start-flame-graph-small.png renamed to experimental/aws-lambda-java-profiler/docs/example-cold-start-flame-graph-small.png

@@ -14,7 +14,7 @@
 
 public class S3Manager {
 
-    private static final String RESULTS_BUCKET = "PROFILER_RESULTS_BUCKET_NAME";
+    private static final String RESULTS_BUCKET = "AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME";
     private static final String FUNCTION_NAME = System.getenv().getOrDefault("AWS_LAMBDA_FUNCTION_NAME", "function");
     private S3Client s3Client;
     private String bucketName;
@@ -23,7 +23,7 @@ public S3Manager() {
         final String bucketName = System.getenv(RESULTS_BUCKET);
         Logger.debug("creating S3Manager with bucketName = " + bucketName);
         if (null == bucketName || bucketName.isEmpty()) {
-            throw new IllegalArgumentException("please set the bucket name using PROFILER_RESULTS_BUCKET_NAME environment variable");
+            throw new IllegalArgumentException("please set the bucket name using AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME environment variable");
         }
         this.s3Client = S3Client.builder().build();
         this.bucketName = bucketName;

aws-lambda-java-profiler/docs/example-cold-start-flame-graph.png renamed to experimental/aws-lambda-java-profiler/docs/example-cold-start-flame-graph.png

@@ -8,7 +8,7 @@ RUNTIME="java21"
 LAYER_ARN=$(cat /tmp/layer_arn)
 
 JAVA_TOOL_OPTIONS="-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints -javaagent:/opt/profiler-extension.jar"
-PROFILER_RESULTS_BUCKET_NAME="aws-lambda-java-profiler-bucket-${GITHUB_RUN_ID}"
+AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME="aws-lambda-java-profiler-bucket-${GITHUB_RUN_ID}"
 
 # Compile the Hello World project
 cd integration_tests/helloworld
@@ -35,7 +35,7 @@ POLICY_DOCUMENT=$(cat <<EOF
         {
             "Effect": "Allow",
             "Action": "s3:PutObject",
-            "Resource": "arn:aws:s3:::$PROFILER_RESULTS_BUCKET_NAME/*"
+            "Resource": "arn:aws:s3:::$AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME/*"
         }
     ]
 }
@@ -60,7 +60,7 @@ aws lambda create-function \
     --timeout 30 \
     --memory-size 512 \
     --zip-file fileb://integration_tests/helloworld/build/distributions/code.zip \
-    --environment "Variables={JAVA_TOOL_OPTIONS='$JAVA_TOOL_OPTIONS',PROFILER_RESULTS_BUCKET_NAME='$PROFILER_RESULTS_BUCKET_NAME',PROFILER_DEBUG='true'}" \
+    --environment "Variables={JAVA_TOOL_OPTIONS='$JAVA_TOOL_OPTIONS',AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME='$AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME',AWS_LAMBDA_PROFILER_DEBUG='true'}" \
     --layers "$LAYER_ARN"
 
 echo "Lambda function '$FUNCTION_NAME' created successfully with Java 21 runtime"

aws-lambda-java-profiler/examples/cdk/.gitignore renamed to experimental/aws-lambda-java-profiler/examples/cdk/.gitignore

@@ -34,7 +34,7 @@ aws lambda update-function-configuration \
 # Add environment variables
 aws lambda update-function-configuration \
     --function-name "$FUNCTION_NAME" \
-    --environment "Variables={PROFILER_RESULTS_BUCKET_NAME=$BUCKET_NAME, JAVA_TOOL_OPTIONS=-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints -javaagent:/opt/profiler-extension.jar}"
+    --environment "Variables={AWS_LAMBDA_PROFILER_RESULTS_BUCKET_NAME=$BUCKET_NAME, JAVA_TOOL_OPTIONS=-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints -javaagent:/opt/profiler-extension.jar}"
 
 # Update the function's permissions to write to the S3 bucket
 # Get the function's execution role