basic X-Ray integration

Author: Michael Wunderlich

.ebextensions/xray.config

@@ -0,0 +1,23 @@
+commands:
+  01-stop-tracing:
+    command: yum remove -y xray
+    ignoreErrors: true
+  02-copy-tracing:
+    command: curl https://s3.amazonaws.com/aws-xray-assets.us-east-1/xray-daemon/aws-xray-daemon-1.x.rpm -o /home/ec2-user/xray.rpm
+  03-start-tracing:
+    command: yum install -y /home/ec2-user/xray.rpm
+
+files:
+  "/opt/elasticbeanstalk/tasks/taillogs.d/xray-daemon.conf" :
+    mode: "000644"
+    owner: root
+    group: root
+    content: |
+      /var/log/xray/xray.log
+  "/etc/amazon/xray/cfg.yaml" :
+    mode: "000644"
+    owner: root
+    group: root
+    content: |
+      Logging:
+        LogLevel: "warn"

Buildfile

@@ -1 +1 @@
-build: gradle build
+01build: gradle build

bin/full-traces.sh

@@ -0,0 +1,4 @@
+EPOCH=$(date +%s)
+echo "epoch is $EPOCH"
+TRACEIDS=$(aws xray get-trace-summaries --start-time $(($EPOCH-120)) --end-time $(($EPOCH-60)) --query 'TraceSummaries[*].Id' --output text | cut -c 1-180)
+aws xray batch-get-traces --trace-ids $TRACEIDS --query 'Traces[*]'

bin/put-trace-segments.sh

@@ -0,0 +1 @@
+aws xray put-trace-segments --trace-segment-documents "{\"id\":\"20312a0e2b8809f4\",\"name\":\"DynamoDB\",\"trace_id\":\"1-5832862d-a43aafded3334a971fe312db\",\"start_time\":1.479706157195E9,\"end_time\":1.479706157202E9,\"parent_id\":\"79736b962fe3239e\",\"http\":{\"response\":{\"content_length\":60,\"status\":200}},\"inferred\":true,\"aws\":{\"consistent_read\":false,\"table_name\":\"scorekeep-session-xray\",\"operation\":\"GetItem\",\"request_id\":\"SCAU23OM6M8FO38UASGC7785ARVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-session-xray\"]},\"origin\":\"AWS::DynamoDB::Table\"}"

bin/service-graph.sh

@@ -0,0 +1,3 @@
+EPOCH=$(date +%s)
+echo "epoch is $EPOCH"
+aws xray get-service-graph --start-time $(($EPOCH-600)) --end-time $EPOCH

bin/trace-summaries.sh

@@ -0,0 +1,4 @@
+EPOCH=$(date +%s)
+echo "epoch is $EPOCH"
+aws xray get-trace-summaries --start-time $(($EPOCH-120)) --end-time $(($EPOCH-60))
+

bin/trace-urls.sh

@@ -0,0 +1,3 @@
+EPOCH=$(date +%s)
+echo "epoch is $EPOCH"
+aws xray get-trace-summaries --start-time $(($EPOCH-120)) --end-time $(($EPOCH-60)) --query 'TraceSummaries[*].Http.HttpURL'

build.gradle

@@ -30,13 +30,18 @@ dependencies {
     compile("org.springframework.boot:spring-boot-starter-web")
     testCompile("org.springframework.boot:spring-boot-starter-test")
     compile("com.amazonaws:aws-java-sdk-dynamodb")
+    compile("com.amazonaws:aws-xray-recorder-sdk-core")
+    compile("com.amazonaws:aws-xray-recorder-sdk-aws-sdk")
+    compile("com.amazonaws:aws-xray-recorder-sdk-aws-sdk-instrumentor")
     testCompile("junit:junit:4.11")
     compile("com.fasterxml.jackson.core:jackson-databind:2.8.4")
+    compile("commons-validator:commons-validator:1.5.1")
 }
 
 dependencyManagement {
     imports {
-        mavenBom("com.amazonaws:aws-java-sdk-bom:1.11.39")
+        mavenBom("com.amazonaws:aws-java-sdk-bom:1.11.52")
+        mavenBom("com.amazonaws:aws-xray-recorder-sdk-bom:1.0.0-beta")
     }
 }
 task wrapper(type: Wrapper) {

src/main/java/scorekeep/WebConfig.java

@@ -1,13 +1,35 @@
 package scorekeep;
-import org.springframework.context.annotation.Configuration;
+
+import com.amazonaws.xray.AWSXRay;
+import com.amazonaws.xray.AWSXRayRecorderBuilder;
+import com.amazonaws.xray.javax.servlet.AWSXRayServletFilter;
+import com.amazonaws.xray.plugins.EC2Plugin;
+import com.amazonaws.xray.strategy.sampling.DefaultSamplingStrategy;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
 import javax.servlet.Filter;
+import java.net.URL;
 
 @Configuration
 public class WebConfig {
 
+  @Bean
+  public Filter TracingFilter() {
+    return new AWSXRayServletFilter();
+  }
+
   @Bean
   public Filter SimpleCORSFilter() {
     return new SimpleCORSFilter();
   }
-}
+
+  static {
+    AWSXRayRecorderBuilder builder = AWSXRayRecorderBuilder.standard().withPlugin(new EC2Plugin());
+
+    URL ruleFile = WebConfig.class.getResource("/sampling-rules.json");
+    builder.withSamplingStrategy(new DefaultSamplingStrategy(ruleFile));
+
+    AWSXRay.setGlobalRecorder(builder.build());
+  }
+}

src/main/resources/sampling-rules.json

@@ -0,0 +1,28 @@
+{
+  "rules": {
+    "user": {
+      "id": 1,
+      "service_name": "*",
+      "http_method": "POST",
+      "url_path": "/api/user",
+      "fixed_target": 10,
+      "rate": 1.0
+    },
+    "move": {
+      "id": 2,
+      "service_name": "*",
+      "http_method": "*",
+      "url_path": "/api/move/*",
+      "fixed_target": 1,
+      "rate": 0.05
+    },
+    "base": {
+      "id": 3,
+      "service_name": "*",
+      "http_method": "*",
+      "url_path": "*",
+      "fixed_target": 10,
+      "rate": 0.25
+    }
+  }
+}