feat: Adding E2E tracing test for RDS database interactions (#101)

This change introduces E2E trace test for Application Signals <-> RDS
database interaction in EKS Java workflow.

Author: jerry-shao

.github/workflows/java-eks-e2e-test.yml

@@ -408,6 +408,7 @@ jobs:
           --platform-info ${{ env.CLUSTER_NAME }}
           --service-name sample-application-${{ env.TESTING_ID }}
           --remote-service-deployment-name ${{ env.REMOTE_SERVICE_DEPLOYMENT_NAME }}
+          --remote-resource-identifier "information_schema|${{env.RDS_MYSQL_CLUSTER_ENDPOINT}}|3306"
           --query-string ip=${{ env.REMOTE_SERVICE_POD_IP }}&testingId=${{ env.TESTING_ID }}
           --rollup'
 

validator/src/main/java/com/amazon/aoc/fileconfigs/PredefinedExpectedTemplate.java

@@ -41,6 +41,7 @@ public enum PredefinedExpectedTemplate implements FileConfig {
 
   JAVA_EKS_RDS_MYSQL_LOG("/expected-data-template/java/eks/rds-mysql-log.mustache"),
   JAVA_EKS_RDS_MYSQL_METRIC("/expected-data-template/java/eks/rds-mysql-metric.mustache"),
+  JAVA_EKS_RDS_MYSQL_TRACE("/expected-data-template/java/eks/rds-mysql-trace.mustache"),
 
   /** Java EC2 Default Test Case Validations */
   JAVA_EC2_DEFAULT_OUTGOING_HTTP_CALL_LOG("/expected-data-template/java/ec2/default/outgoing-http-call-log.mustache"),

validator/src/main/resources/expected-data-template/java/eks/rds-mysql-trace.mustache

@@ -0,0 +1,86 @@
+[
+    {
+        "name": "^{{serviceName}}$",
+        "http": {
+            "request": {
+                "url": "^{{endpoint}}/mysql$",
+                "method": "^GET$"
+            },
+            "response": {
+                "status": 200
+            }
+        },
+        "aws": {
+            "account_id": "^{{accountId}}$",
+            "xray": {
+                "auto_instrumentation": true,
+                "sdk": "^opentelemetry for"
+            }
+        },
+        "annotations": {
+            "aws.local.service": "^{{serviceName}}$",
+            "aws.local.operation": "^GET /mysql$",
+            "aws.local.environment": "^eks:{{platformInfo}}/{{appNamespace}}$"
+        },
+        "metadata": {
+            "default": {
+                "EC2.AutoScalingGroup": "^eks-.+",
+                "EKS.Cluster": "^{{platformInfo}}$",
+                "K8s.Namespace": "^{{appNamespace}}",
+                "otel.resource.K8s.Workload": "^sample-app-deployment-{{testingId}}",
+                "otel.resource.K8s.Node": "^i-[A-Za-z0-9]{17}$",
+                "otel.resource.K8s.Pod": "^sample-app-deployment-{{testingId}}(-[A-Za-z0-9]*)*$",
+                "otel.resource.host.name": "^ip(-[0-9]{1,3}){4}.*$",
+                "PlatformType": "^AWS::EKS$",
+                "aws.span.kind": "^LOCAL_ROOT$",
+                "http.route": "^/mysql$"
+            }
+        },
+        "subsegments": [
+            {
+                "name": "^FrontendServiceController.mysql$",
+                "aws": {
+                    "account_id": "^{{accountId}}$",
+                    "xray": {
+                        "auto_instrumentation": true,
+                        "sdk": "^opentelemetry for"
+                    }
+                },
+                "annotations": {
+                    "aws.local.operation": "^GET /mysql$"
+                },
+                "subsegments": [
+                    {
+                        "name": "^mysql$",
+                        "sql": {
+                            "url": "^SELECT information_schema.tables$",
+                            "sanitized_query": "SELECT \\* FROM tables LIMIT \\?;",
+                            "database_type": "^mysql$"
+                        },
+                        "annotations": {
+                            "aws.remote.operation": "^SELECT$",
+                            "aws.local.operation": "^GET /mysql$",
+                            "aws.remote.resource.type": "^DB::Connection$",
+                            "aws.remote.resource.identifier": "{{remoteResourceIdentifier}}",
+                            "aws.remote.service": "^mysql$",
+                            "aws.local.service": "^{{serviceName}}$",
+                            "aws.local.environment": "^eks:{{platformInfo}}/{{appNamespace}}$"
+                        },
+                        "metadata": {
+                            "default": {
+                                "EC2.AutoScalingGroup": "^eks-.+",
+                                "EKS.Cluster": "^{{platformInfo}}$",
+                                "K8s.Namespace": "^{{appNamespace}}$",
+                                "PlatformType": "^AWS::EKS$",
+                                "aws.span.kind": "^CLIENT$",
+                                "db.sql.table": "^tables$",
+                                "db.operation": "^SELECT$"
+                            }
+                        },
+                        "namespace": "^remote$"
+                    }
+                ]
+            }
+        ]
+    }
+]

validator/src/main/resources/validations/java/eks/trace-validation.yml

@@ -21,4 +21,10 @@
   httpPath: "/client-call"
   httpMethod: "get"
   callingType: "http"
-  expectedTraceTemplate: "JAVA_EKS_CLIENT_CALL_TRACE"
+  expectedTraceTemplate: "JAVA_EKS_CLIENT_CALL_TRACE"
+-
+  validationType: "trace"
+  httpPath: "/mysql"
+  httpMethod: "get"
+  callingType: "http"
+  expectedTraceTemplate: "JAVA_EKS_RDS_MYSQL_TRACE"