Merge branch 'main' into dependabot/gradle/org.testcontainers-mysql-1.20.3

Author: vastin

.github/workflows/main-build.yml

@@ -157,19 +157,22 @@ jobs:
             echo "ref=terraform" >> $GITHUB_OUTPUT
           fi
 
-  e2e-operator-test:
-    concurrency:
-      group: e2e-adot-agent-operator-test
-      cancel-in-progress: false
-    needs: [ build, create-test-ref, default-region-output ]
-    uses: ./.github/workflows/e2e-tests-with-operator.yml
-    secrets: inherit
-    with:
-      aws-region: ${{ needs.default-region-output.outputs.aws_default_region }}
-      image_tag: ${{ needs.build.outputs.java_agent_tag }}
-      image_uri: ${{ needs.build.outputs.staging_registry }}/${{ needs.build.outputs.staging_repository }}
-      test_ref: ${{ needs.create-test-ref.outputs.testRef }}
-      caller-workflow-name: 'main-build'
+  # TODO: This test is currently failing due to infrastructure problems. Commented it out because we are ignoring it during release. 
+  # Need to fix in the future. Ex: https://github.com/aws-observability/aws-otel-java-instrumentation/actions/runs/11525535146/job/32241628521
+
+  # e2e-operator-test:
+  #   concurrency:
+  #     group: e2e-adot-agent-operator-test
+  #     cancel-in-progress: false
+  #   needs: [ build, create-test-ref, default-region-output ]
+  #   uses: ./.github/workflows/e2e-tests-with-operator.yml
+  #   secrets: inherit
+  #   with:
+  #     aws-region: ${{ needs.default-region-output.outputs.aws_default_region }}
+  #     image_tag: ${{ needs.build.outputs.java_agent_tag }}
+  #     image_uri: ${{ needs.build.outputs.staging_registry }}/${{ needs.build.outputs.staging_repository }}
+  #     test_ref: ${{ needs.create-test-ref.outputs.testRef }}
+  #     caller-workflow-name: 'main-build'
 
   # E2E tests where SampleApp has Java Agent
   e2e-test:

.github/workflows/owasp.yml

@@ -77,15 +77,15 @@ jobs:
         id: high_scan
         uses: ./.github/actions/image_scan
         with:
-          image-ref: "public.ecr.aws/aws-observability/adot-autoinstrumentation-java:v1.32.4"
+          image-ref: "public.ecr.aws/aws-observability/adot-autoinstrumentation-java:v1.32.5"
           severity: 'CRITICAL,HIGH'
 
       - name: Perform low image scan
         if: always()
         id: low_scan
         uses: ./.github/actions/image_scan
         with:
-          image-ref: "public.ecr.aws/aws-observability/adot-autoinstrumentation-java:v1.32.4"
+          image-ref: "public.ecr.aws/aws-observability/adot-autoinstrumentation-java:v1.32.5"
           severity: 'MEDIUM,LOW,UNKNOWN'
 
       - name: Configure AWS Credentials for emitting metrics

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/base/ContractTestBase.java

@@ -48,16 +48,19 @@ public abstract class ContractTestBase {
 
   private final Logger collectorLogger =
       LoggerFactory.getLogger("collector " + getApplicationOtelServiceName());
-  private final Logger applicationLogger =
+  protected final Logger applicationLogger =
       LoggerFactory.getLogger("application " + getApplicationOtelServiceName());
 
-  private static final String AGENT_PATH =
+  protected static final String AGENT_PATH =
       System.getProperty("io.awsobservability.instrumentation.contracttests.agentPath");
+  protected static final String MOUNT_PATH = "/opentelemetry-javaagent-all.jar";
 
   protected final Network network = Network.newNetwork();
 
   private static final String COLLECTOR_HOSTNAME = "collector";
   private static final int COLLECTOR_PORT = 4317;
+  protected static final String COLLECTOR_HTTP_ENDPOINT =
+      "http://" + COLLECTOR_HOSTNAME + ":" + COLLECTOR_PORT;
 
   protected final GenericContainer<?> mockCollector =
       new GenericContainer<>("aws-appsignals-mock-collector")
@@ -67,30 +70,7 @@ public abstract class ContractTestBase {
           .withNetwork(network)
           .withNetworkAliases(COLLECTOR_HOSTNAME);
 
-  protected final GenericContainer<?> application =
-      new GenericContainer<>(getApplicationImageName())
-          .dependsOn(getDependsOn())
-          .withExposedPorts(getApplicationPort())
-          .withNetwork(network)
-          .withLogConsumer(new Slf4jLogConsumer(applicationLogger))
-          .withCopyFileToContainer(
-              MountableFile.forHostPath(AGENT_PATH), "/opentelemetry-javaagent-all.jar")
-          .waitingFor(getApplicationWaitCondition())
-          .withEnv("JAVA_TOOL_OPTIONS", "-javaagent:/opentelemetry-javaagent-all.jar")
-          .withEnv("OTEL_METRIC_EXPORT_INTERVAL", "100") // 100 ms
-          .withEnv("OTEL_AWS_APPLICATION_SIGNALS_ENABLED", "true")
-          .withEnv("OTEL_AWS_APPLICATION_SIGNALS_RUNTIME_ENABLED", isRuntimeEnabled())
-          .withEnv("OTEL_METRICS_EXPORTER", "none")
-          .withEnv("OTEL_BSP_SCHEDULE_DELAY", "0") // Don't wait to export spans to the collector
-          .withEnv(
-              "OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT",
-              "http://" + COLLECTOR_HOSTNAME + ":" + COLLECTOR_PORT)
-          .withEnv(
-              "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT",
-              "http://" + COLLECTOR_HOSTNAME + ":" + COLLECTOR_PORT)
-          .withEnv("OTEL_RESOURCE_ATTRIBUTES", getApplicationOtelResourceAttributes())
-          .withEnv(getApplicationExtraEnvironmentVariables())
-          .withNetworkAliases(getApplicationNetworkAliases().toArray(new String[0]));
+  protected final GenericContainer<?> application = getApplicationContainer();
 
   protected MockCollectorClient mockCollectorClient;
   protected WebClient appClient;
@@ -109,10 +89,8 @@ private void stopCollector() {
   protected void setupClients() {
     application.start();
 
-    appClient = WebClient.of("http://localhost:" + application.getMappedPort(8080));
-    mockCollectorClient =
-        new MockCollectorClient(
-            WebClient.of("http://localhost:" + mockCollector.getMappedPort(4317)));
+    appClient = getApplicationClient();
+    mockCollectorClient = getMockCollectorClient();
   }
 
   @AfterEach
@@ -128,11 +106,55 @@ private List<Startable> getDependsOn() {
     return dependencies;
   }
 
+  protected WebClient getApplicationClient() {
+    return WebClient.of("http://localhost:" + application.getMappedPort(8080));
+  }
+
+  protected MockCollectorClient getMockCollectorClient() {
+    return new MockCollectorClient(
+        WebClient.of("http://localhost:" + mockCollector.getMappedPort(4317)));
+  }
+
+  protected GenericContainer<?> getApplicationContainer() {
+    return new GenericContainer<>(getApplicationImageName())
+        .dependsOn(getDependsOn())
+        .withExposedPorts(getApplicationPort())
+        .withNetwork(network)
+        .withLogConsumer(new Slf4jLogConsumer(applicationLogger))
+        .withCopyFileToContainer(MountableFile.forHostPath(AGENT_PATH), MOUNT_PATH)
+        .waitingFor(getApplicationWaitCondition())
+        .withEnv(getApplicationEnvironmentVariables())
+        .withEnv(getApplicationExtraEnvironmentVariables())
+        .withNetworkAliases(getApplicationNetworkAliases().toArray(new String[0]));
+  }
+
   /** Methods that should be overridden in sub classes * */
   protected int getApplicationPort() {
     return 8080;
   }
 
+  protected Map<String, String> getApplicationEnvironmentVariables() {
+    return Map.of(
+        "JAVA_TOOL_OPTIONS",
+        "-javaagent:" + MOUNT_PATH,
+        "OTEL_METRIC_EXPORT_INTERVAL",
+        "100", // 100 ms
+        "OTEL_AWS_APPLICATION_SIGNALS_ENABLED",
+        "true",
+        "OTEL_AWS_APPLICATION_SIGNALS_RUNTIME_ENABLED",
+        isRuntimeEnabled(),
+        "OTEL_METRICS_EXPORTER",
+        "none",
+        "OTEL_BSP_SCHEDULE_DELAY",
+        "0", // Don't wait to export spans to the collector
+        "OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT",
+        COLLECTOR_HTTP_ENDPOINT,
+        "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT",
+        COLLECTOR_HTTP_ENDPOINT,
+        "OTEL_RESOURCE_ATTRIBUTES",
+        getApplicationOtelResourceAttributes());
+  }
+
   protected Map<String, String> getApplicationExtraEnvironmentVariables() {
     return Map.of();
   }

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/base/JMXMetricsContractTestBase.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.opentelemetry.appsignals.test.base;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.proto.metrics.v1.NumberDataPoint;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.Consumer;
+import software.amazon.opentelemetry.appsignals.test.utils.JMXMetricsConstants;
+
+public abstract class JMXMetricsContractTestBase extends ContractTestBase {
+
+  @Override
+  protected Map<String, String> getApplicationEnvironmentVariables() {
+    return Map.of(
+        "JAVA_TOOL_OPTIONS", "-javaagent:" + MOUNT_PATH,
+        "OTEL_METRIC_EXPORT_INTERVAL", "100", // 100 ms
+        "OTEL_METRICS_EXPORTER", "none",
+        "OTEL_LOGS_EXPORTER", "none",
+        "OTEL_TRACES_EXPORTER", "none",
+        "OTEL_EXPORTER_OTLP_PROTOCOL", "http/protobuf",
+        "OTEL_JMX_ENABLED", "true",
+        "OTEL_AWS_JMX_EXPORTER_METRICS_ENDPOINT", COLLECTOR_HTTP_ENDPOINT + "/v1/metrics");
+  }
+
+  protected void doTestMetrics() {
+    var response = appClient.get("/success").aggregate().join();
+
+    assertThat(response.status().isSuccess()).isTrue();
+    assertMetrics();
+  }
+
+  protected void assertMetrics() {
+    var metrics = mockCollectorClient.getRuntimeMetrics(getExpectedMetrics());
+    metrics.forEach(
+        metric -> {
+          var dataPoints = metric.getMetric().getGauge().getDataPointsList();
+          assertGreaterThanOrEqual(dataPoints, getThreshold(metric.getMetric().getName()));
+        });
+  }
+
+  protected abstract Set<String> getExpectedMetrics();
+
+  protected long getThreshold(String metricName) {
+    long threshold = 0;
+    switch (metricName) {
+        // If maximum memory size is undefined, then value is -1
+        // https://docs.oracle.com/en/java/javase/17/docs/api/java.management/java/lang/management/MemoryUsage.html#getMax()
+      case JMXMetricsConstants.JVM_HEAP_MAX:
+      case JMXMetricsConstants.JVM_NON_HEAP_MAX:
+      case JMXMetricsConstants.JVM_POOL_MAX:
+        threshold = -1;
+      default:
+    }
+    return threshold;
+  }
+
+  private void assertGreaterThanOrEqual(List<NumberDataPoint> dps, long threshold) {
+    assertDataPoints(dps, (value) -> assertThat(value).isGreaterThanOrEqualTo(threshold));
+  }
+
+  private void assertDataPoints(List<NumberDataPoint> dps, Consumer<Long> consumer) {
+    dps.forEach(datapoint -> consumer.accept(datapoint.getAsInt()));
+  }
+}

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/misc/jmx/JVMMetricsTest.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.opentelemetry.appsignals.test.misc.jmx;
+
+import java.util.Map;
+import java.util.Set;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import software.amazon.opentelemetry.appsignals.test.base.JMXMetricsContractTestBase;
+import software.amazon.opentelemetry.appsignals.test.utils.JMXMetricsConstants;
+
+/**
+ * Tests in this class validate that the SDK will emit JVM metrics when Application Signals runtime
+ * metrics are enabled.
+ */
+@Testcontainers(disabledWithoutDocker = true)
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class JVMMetricsTest extends JMXMetricsContractTestBase {
+  @Test
+  void testJVMMetrics() {
+    doTestMetrics();
+  }
+
+  @Override
+  protected String getApplicationImageName() {
+    return "aws-appsignals-tests-http-server-spring-mvc";
+  }
+
+  @Override
+  protected String getApplicationWaitPattern() {
+    return ".*Started Application.*";
+  }
+
+  @Override
+  protected Set<String> getExpectedMetrics() {
+    return JMXMetricsConstants.JVM_METRICS_SET;
+  }
+
+  @Override
+  protected Map<String, String> getApplicationExtraEnvironmentVariables() {
+    return Map.of("OTEL_JMX_TARGET_SYSTEM", "jvm");
+  }
+}