Pin containers to CPU cores and update license file headers (#92)

In this PR, we are pinning containers to specific CPU cores to avoid
resource contention for performance test. Also we are updating logic for
the license file headers as some files are unrelated to OTEL files.

Testing:
```
>./gradlew test -i
...
[Test worker] INFO io.opentelemetry.util.RuntimeUtil - Assume running on Linux.
[Test worker] INFO io.opentelemetry.util.RuntimeUtil - Non-App Cores: 0-3.
[Test worker] INFO io.opentelemetry.util.RuntimeUtil - App Cores: 4-7.
...
OverheadTests > runAllTestConfigurations() > all-800-tps STANDARD_OUT
    ----------------------------------------------------------
     Run at Fri Mar 01 21:24:39 UTC 2024
     all-800-tps : Compares all DistroConfigs (800TPS test)
     5 users, 10s duration
    ----------------------------------------------------------
    DistroConfig                  :                      none     app_signals_disabled    app_signals_no_traces       app_signals_traces
    Run duration                  :                  00:00:12                 00:00:13                 00:00:13                 00:00:12
    Avg. CPU (user) %             :                       0.0                      0.0                      0.0                      0.0
    Max. CPU (user) %             :                       0.0                      0.0                      0.0                      0.0
    Avg. mch tot cpu %            :                       0.0                      0.0                      0.0                      0.0
    Startup time (ms)             :                      4012                     5014                     5014                     5026
    Total allocated MB            :                      0.00                     0.00                     0.00                     0.00
    Thread switch rate            :                       0.0                      0.0                      0.0                      0.0
    GC time (ms)                  :                         0                        0                        0                        0
    GC pause time (ms)            :                         0                        0                        0                        0
    Req. mean (ms)                :                    103.00                   102.45                   102.21                   103.55
    Req. p95 (ms)                 :                    389.91                   389.93                   389.89                   389.93
    Iter. mean (ms)               :                   1451.32                  1443.18                  1438.49                  1459.08
    Iter. p95 (ms)                :                   1570.30                  1581.58                  1622.25                  1570.49
    Net read avg (bps)            :                      0.00                     0.00                     0.00                     0.00
    Net write avg (bps)           :                      0.00                     0.00                     0.00                     0.00
    Peak threads                  :                         0                        0                        0                        0

Gradle Test Executor 3 finished executing tests.

> Task :test
Finished generating test XML results (0.049 secs) into: /workplace/thp/python-sdk/aws-otel-python-instrumentation/performance-tests/build/test-results/test
Generating HTML test report...
Finished generating test html results (0.053 secs) into: /workplace/thp/python-sdk/aws-otel-python-instrumentation/performance-tests/build/reports/tests/test

Deprecated Gradle features were used in this build, making it incompatible with Gradle 9.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

For more on this, please refer to https://docs.gradle.org/8.6/userguide/command_line_interface.html#sec:command_line_warnings in the Gradle documentation.

BUILD SUCCESSFUL in 3m 28s
3 actionable tasks: 1 executed, 2 up-to-date
```

By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

Author: thpierce

performance-tests/build.gradle.kts

@@ -6,7 +6,12 @@ plugins {
 spotless {
   java {
     googleJavaFormat()
+    licenseHeaderFile(rootProject.file("../scripts/spotless.modify_license.java"), "(package|import|public)")
+            .named("modify_license")
+            .onlyIfContentMatches("!.*RuntimeUtil.java")
     licenseHeaderFile(rootProject.file("../scripts/spotless.license.java"), "(package|import|public)")
+            .named("license")
+            .onlyIfContentMatches(".*RuntimeUtil.java")
     target("src/**/*.java")
   }
 }

performance-tests/src/test/java/io/opentelemetry/containers/CollectorContainer.java

@@ -6,6 +6,7 @@
 
 package io.opentelemetry.containers;
 
+import io.opentelemetry.util.RuntimeUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.GenericContainer;
@@ -33,6 +34,8 @@ public static GenericContainer<?> build(Network network) {
         .waitingFor(Wait.forHttp("/health").forPort(COLLECTOR_HEALTH_CHECK_PORT))
         .withCopyFileToContainer(
             MountableFile.forClasspathResource("collector.yaml"), "/etc/otel.yaml")
+        .withCreateContainerCmdModifier(
+            cmd -> cmd.getHostConfig().withCpusetCpus(RuntimeUtil.getNonApplicationCores()))
         .withCommand("--config /etc/otel.yaml");
   }
 }

performance-tests/src/test/java/io/opentelemetry/containers/ImageServiceContainer.java

@@ -6,6 +6,7 @@
 
 package io.opentelemetry.containers;
 
+import io.opentelemetry.util.RuntimeUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.GenericContainer;
@@ -45,6 +46,8 @@ public GenericContainer<?> build() {
         .withEnv("AWS_SECRET_ACCESS_KEY", System.getenv("AWS_SECRET_ACCESS_KEY"))
         .withEnv("AWS_SESSION_TOKEN", System.getenv("AWS_SESSION_TOKEN"))
         .withEnv("S3_BUCKET", System.getenv("S3_BUCKET"))
+        .withCreateContainerCmdModifier(
+            cmd -> cmd.getHostConfig().withCpusetCpus(RuntimeUtil.getNonApplicationCores()))
         .withCommand(String.format("python3 manage.py runserver 0.0.0.0:%s --noreload", PORT));
   }
 }

performance-tests/src/test/java/io/opentelemetry/containers/K6Container.java

@@ -9,6 +9,7 @@
 import io.opentelemetry.config.TestConfig;
 import io.opentelemetry.distros.DistroConfig;
 import io.opentelemetry.util.NamingConventions;
+import io.opentelemetry.util.RuntimeUtil;
 import java.nio.file.Path;
 import java.time.Duration;
 import org.slf4j.Logger;
@@ -60,6 +61,8 @@ public GenericContainer<?> build() {
             "--summary-trend-stats",
             "avg,p(0),p(50),p(90),p(99),p(100),count",
             "/app/performanceTest.js")
+        .withCreateContainerCmdModifier(
+            cmd -> cmd.getHostConfig().withCpusetCpus(RuntimeUtil.getNonApplicationCores()))
         .withStartupCheckStrategy(
             new OneShotStartupCheckStrategy().withTimeout(Duration.ofMinutes(15)));
   }

performance-tests/src/test/java/io/opentelemetry/containers/PostgresContainer.java

@@ -6,6 +6,7 @@
 
 package io.opentelemetry.containers;
 
+import io.opentelemetry.util.RuntimeUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.Network;
@@ -34,6 +35,8 @@ public PostgreSQLContainer<?> build() throws Exception {
         .withUsername(USERNAME)
         .withPassword(PASSWORD)
         .withDatabaseName(DATABASE_NAME)
+        .withCreateContainerCmdModifier(
+            cmd -> cmd.getHostConfig().withCpusetCpus(RuntimeUtil.getNonApplicationCores()))
         .withReuse(false);
   }
 }

performance-tests/src/test/java/io/opentelemetry/containers/VehicleInventoryServiceContainer.java

@@ -7,6 +7,7 @@
 package io.opentelemetry.containers;
 
 import io.opentelemetry.distros.DistroConfig;
+import io.opentelemetry.util.RuntimeUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.GenericContainer;
@@ -57,6 +58,8 @@ public GenericContainer<?> build() {
             .withEnv("IMAGE_BACKEND_SERVICE_PORT", Integer.toString(ImageServiceContainer.PORT))
             .withEnv(distroConfig.getAdditionalEnvVars())
             .dependsOn(collector)
+            .withCreateContainerCmdModifier(
+                cmd -> cmd.getHostConfig().withCpusetCpus(RuntimeUtil.getApplicationCores()))
             .withCommand("bash run.sh");
 
     if (distroConfig.doInstrument()) {

performance-tests/src/test/java/io/opentelemetry/util/RuntimeUtil.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.util;
+
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class RuntimeUtil {
+  private static final Logger logger = LoggerFactory.getLogger(RuntimeUtil.class);
+  private static final int CORE_COUNT = getCpuCoreCount();
+
+  /**
+   * Get cores dedicated for application container being performance tested, to reduce chances of
+   * CPU resource contention causing application slowdown. E.g. if 6 core system, "3-5"
+   */
+  public static String getApplicationCores() {
+    String cpus = String.format("%s-%s", CORE_COUNT / 2, CORE_COUNT - 1);
+    logger.info(String.format("App Cores: %s.", cpus));
+    return cpus;
+  }
+
+  /** Get cores for all other containers. E.g. if 6 core system, "0-2" */
+  public static String getNonApplicationCores() {
+    String cpus = String.format("0-%s", CORE_COUNT / 2 - 1);
+    logger.info(String.format("Non-App Cores: %s.", cpus));
+    return cpus;
+  }
+
+  private static int getCpuCoreCount() {
+    String os = System.getProperty("os.name").toLowerCase();
+    try {
+      if (os.contains("mac")) {
+        logger.info("Detected running on MacOS.");
+        return getCoreCountMac();
+      } else {
+        logger.info("Assume running on Linux.");
+        return getCoreCountLinux();
+      }
+    } catch (Exception e) {
+      throw new RuntimeException(e);
+    }
+  }
+
+  private static int getCoreCountMac() throws Exception {
+    String command = "sysctl -n hw.ncpu";
+    String[] cmd = {"/bin/sh", "-c", command};
+    Process process = Runtime.getRuntime().exec(cmd);
+    BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()));
+    String line = reader.readLine();
+    return !line.isEmpty() ? Integer.parseInt(line) : 0;
+  }
+
+  private static int getCoreCountLinux() throws Exception {
+    String command = "lscpu";
+    Process process = Runtime.getRuntime().exec(command);
+    BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()));
+    String line = reader.readLine();
+    int threadsPerCore = 0;
+    int coresPerSocket = 0;
+    int sockets = 0;
+    while (line != null) {
+      if (line.contains("Thread(s) per core:")) {
+        threadsPerCore = Integer.parseInt(line.split("\\s+")[line.split("\\s+").length - 1]);
+      }
+      if (line.contains("Core(s) per socket:")) {
+        coresPerSocket = Integer.parseInt(line.split("\\s+")[line.split("\\s+").length - 1]);
+      }
+      if (line.contains("Socket(s):")) {
+        sockets = Integer.parseInt(line.split("\\s+")[line.split("\\s+").length - 1]);
+      }
+      line = reader.readLine();
+    }
+    return threadsPerCore * coresPerSocket * sockets;
+  }
+}

scripts/spotless.license.java

@@ -1,6 +1,5 @@
 /*
- * Copyright The OpenTelemetry Authors
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
- * Modifications Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  */
 

scripts/spotless.modify_license.java

@@ -0,0 +1,6 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ * Modifications Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ */
+