Python CPU test - basic scenario

README.md

@@ -43,14 +43,14 @@ find the pprof files.
 Create a test scenario and prefix the folders with something relevant like `php`, `ddprof`, `go`...
 The dockerfile specifies how to install the profiler and run the test app.
 The dockerfile needs to follow rules
-- set variable `EXECUTION_TIME` (which defines how long the tests runs for)
+- set variable `EXECUTION_TIME_SEC` (which defines how long the tests runs for)
 - output pprof data to the `/app/data/` folder
   The /app/data mirrors the data folder in this repository.
 ```
 # Define OS / Install App...
 # Install profiler...
 # Run things
-ENV EXECUTION_TIME="60"
+ENV EXECUTION_TIME_SEC="60"
 # Default is that test data is dropped in the data folder
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 CMD ["ddprof", "-l", "notice", "/app/build/some_app" ]

correctness_test.go

@@ -111,7 +111,7 @@ func buildTestApp(t *testing.T, config DockerTestConfig) string {
 	return string("test-app")
 }
 
-// docker run -v ${PWD}/data:/app/data:rw -e EXECUTION_TIME=60 -u $(id -u ${USER}):$(id -g ${USER}) --security-opt seccomp=unconfined test-app:latest
+// docker run -v ${PWD}/data:/app/data:rw -e EXECUTION_TIME_SEC=60 -u $(id -u ${USER}):$(id -g ${USER}) --security-opt seccomp=unconfined test-app:latest
 
 func runTestApp(t *testing.T, dockerTag string, folder string) string {
 	currentPath, err := os.Getwd()
@@ -135,7 +135,7 @@ func runTestApp(t *testing.T, dockerTag string, folder string) string {
 	t.Log(strings.Join(cmdSlice, " "))
 	args := []string{"run", "-v", mountOption, "-u", userOption, "--security-opt", "seccomp=unconfined"}
 	if DURATION_SET {
-		args = append(args, "-e", "EXECUTION_TIME="+fmt.Sprint(RUN_SECS))
+		args = append(args, "-e", "EXECUTION_TIME_SEC="+fmt.Sprint(RUN_SECS))
 	}
 	if NETWORK_HOST {
 		args = append(args, "--network=host")
@@ -180,7 +180,7 @@ func testScenarios(t *testing.T, scenarioRegexp string) {
 
 var (
 	expectedJson = flag.String("expectedJson", "default.json", "Path to the expected JSON file")
-	pprofPath = flag.String("pprofPath", "./", "Path to the directory with the pprof")
+	pprofPath    = flag.String("pprofPath", "./", "Path to the directory with the pprof")
 )
 
 func TestAnalyze(t *testing.T) {

scenarios/broken_graal_vm/Dockerfile

@@ -23,7 +23,7 @@ RUN ./install_profiler.sh /usr/local/bin
 
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_NATIVE_LOG_MODE="/app/data/ddprof_log"
-# If upload period is > EXECUTION_TIME, it can cause issues when shutting down containers 
+# If upload period is > EXECUTION_TIME_SEC, it can cause issues when shutting down containers 
 ENV DD_PROFILING_UPLOAD_PERIOD="10"
 
 CMD ddprof -l notice /app/DummyApp 11

scenarios/ddprof_allocations/Dockerfile

@@ -28,7 +28,7 @@ COPY ./binaries/ /app/binaries/
 ADD ./profilers/ddprof/install_profiler.sh .
 RUN ./install_profiler.sh /usr/local/bin
 
-ENV EXECUTION_TIME="11"
+ENV EXECUTION_TIME_SEC="11"
 # Default is that test data is dropped in the data folder
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_UPLOAD_PERIOD="10"

scenarios/ddprof_allocations/simple_malloc.cc

@@ -216,7 +216,7 @@ int main(int argc, char *argv[]) {
     app.add_option<std::chrono::seconds, int64_t>(
            "--timeout", opts.timeout_duration, "Timeout after N seconds")
         ->default_val(0)
-        ->envname("EXECUTION_TIME")
+        ->envname("EXECUTION_TIME_SEC")
         ->check(CLI::NonNegativeNumber);
     app.add_option<std::chrono::microseconds, int64_t>(
            "--spin", opts.spin_duration_per_loop,

scenarios/ddprof_clang_pie/Dockerfile

@@ -29,10 +29,10 @@ FROM base AS final
 ADD ./profilers/ddprof/install_profiler.sh .
 RUN ./install_profiler.sh /usr/local/bin
 
-ENV EXECUTION_TIME="12"
+ENV EXECUTION_TIME_SEC="12"
 # Default is that test data is dropped in the data folder
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_NATIVE_LOG_MODE="/app/data/ddprof_log"
-# If upload period is > EXECUTION_TIME, it can cause issues when shutting down containers 
+# If upload period is > EXECUTION_TIME_SEC, it can cause issues when shutting down containers 
 ENV DD_PROFILING_UPLOAD_PERIOD="10"
 CMD ["ddprof", "-l", "notice", "/app/build/clang_pie" ]

scenarios/ddprof_clang_pie/main.c

@@ -23,7 +23,7 @@ void b() {
 
 int main(int argc, char *argv[]) {
     int test_duration = 60;
-    const char *exec_time_env = getenv("EXECUTION_TIME");
+    const char *exec_time_env = getenv("EXECUTION_TIME_SEC");
     if (exec_time_env) {
         test_duration = atoi(exec_time_env);
         if (test_duration == 0) {

scenarios/ddprof_julia/Dockerfile

@@ -22,7 +22,7 @@ ARG CACHE_DATE=2023-03-01_09:58:27
 ADD ./profilers/ddprof/install_profiler.sh .
 RUN ./install_profiler.sh /usr/local/bin
 
-ENV EXECUTION_TIME="11"
+ENV EXECUTION_TIME_SEC="11"
 # Default is that test data is dropped in the data folder
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_UPLOAD_PERIOD="10"
@@ -33,7 +33,7 @@ ENV ENABLE_JITPROFILING=1
 # The rpath is defined by the caller of dlopen. Intercepting the call changes
 # who is calling dlopen. This is not easy to fix, so I'm adding the path to Julia libs
 # Debug command:
-# ENABLE_JITPROFILING=1 LD_LIBRARY_PATH=~/dd/scripts/julia-1.8.5/lib/julia/ EXECUTION_TIME=30 ddprof -l notice 
+# ENABLE_JITPROFILING=1 LD_LIBRARY_PATH=~/dd/scripts/julia-1.8.5/lib/julia/ EXECUTION_TIME_SEC=30 ddprof -l notice 
 # --show_sample julia scenarios/ddprof_julia/main.jl
 ENV LD_LIBRARY_PATH="/usr/local/julia/lib:${LD_LIBRARY_PATH}"
 RUN mkdir /.debug && mkdir /.debug/jit && chmod 777 /.debug/jit

scenarios/ddprof_julia/main.jl

@@ -3,7 +3,7 @@ include("b.jl")
 
 
 test_duration = 60
-exec_time_env = ENV["EXECUTION_TIME"]
+exec_time_env = ENV["EXECUTION_TIME_SEC"]
 if exec_time_env != nothing
     test_duration = parse(Int, exec_time_env)
     if test_duration == 0

scenarios/ddprof_live_heap/Dockerfile

@@ -21,11 +21,11 @@ FROM base AS final
 ADD ./profilers/ddprof/install_profiler.sh .
 RUN ./install_profiler.sh /usr/local/bin
 
-ENV EXECUTION_TIME="12"
+ENV EXECUTION_TIME_SEC="12"
 # Default is that test data is dropped in the data folder
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_NATIVE_LOG_MODE="/app/data/ddprof_log"
-# If upload period is > EXECUTION_TIME, it can cause issues when shutting down containers 
+# If upload period is > EXECUTION_TIME_SEC, it can cause issues when shutting down containers 
 ENV DD_PROFILING_UPLOAD_PERIOD="10"
 # ddprof -l debug -e "sALLOC period=1 mode=l" -u 30 ./test
 # Force deterministic by sampling all allocations

scenarios/ddprof_live_heap/main.cc

@@ -39,7 +39,7 @@ void thread_function() {
 
 int main(int argc, char** argv) {
     int test_duration = 10;
-    const char* exec_time_env = getenv("EXECUTION_TIME");
+    const char* exec_time_env = getenv("EXECUTION_TIME_SEC");
     if (exec_time_env) {
         test_duration = atoi(exec_time_env);
         if (test_duration == 0) {

scenarios/node_heap/Dockerfile

@@ -8,7 +8,7 @@ COPY ./scenarios/node_heap/* ./
 RUN chmod 755 /app/*
 RUN npm install
 
-ENV EXECUTION_TIME="10"
+ENV EXECUTION_TIME_SEC="10"
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_EXPORTERS=file
 ENV DD_PROFILING_ENABLED=1

scenarios/node_heap/main.js

@@ -30,6 +30,6 @@ async function foo(iterCount, allocPeriodMs) {
 var refs = []
 const allocSize = 1024 * 1024 * 2
 const allocPeriodMs = 100
-const durationMs = (process.argv[2] || process.env.EXECUTION_TIME || 2) * 1000
+const durationMs = (process.argv[2] || process.env.EXECUTION_TIME_SEC || 2) * 1000
 const iterCount = durationMs / allocPeriodMs
 setTimeout(() => foo(iterCount, allocPeriodMs), 100)

scenarios/node_heap_oom/Dockerfile

@@ -8,7 +8,7 @@ COPY ./scenarios/node_heap_oom/* ./
 RUN chmod 755 /app/*
 RUN npm install
 
-ENV EXECUTION_TIME="10"
+ENV EXECUTION_TIME_SEC="10"
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_EXPORTERS=file
 ENV DD_PROFILING_ENABLED=1

scenarios/node_heap_oom/main.js

@@ -7,5 +7,5 @@ async function foo(size) {
   for (let i = 0; i < n; i++) { x[i] = Math.random() }
 }
 
-const durationMs = (process.argv[2] || process.env.EXECUTION_TIME || 2) * 1000
+const durationMs = (process.argv[2] || process.env.EXECUTION_TIME_SEC || 2) * 1000
 setTimeout(() => foo(1024 * 1024 * 50), durationMs)

scenarios/node_wall/Dockerfile

@@ -8,7 +8,7 @@ COPY ./scenarios/node_wall/* ./
 RUN chmod 755 /app/*
 RUN npm install
 
-ENV EXECUTION_TIME="10"
+ENV EXECUTION_TIME_SEC="10"
 ENV DD_PROFILING_PPROF_PREFIX="/app/data/profiles_"
 ENV DD_PROFILING_EXPORTERS=file
 ENV DD_PROFILING_ENABLED=1

scenarios/node_wall/main.js

@@ -52,5 +52,5 @@ async function foo(nsecs) {
   setImmediate(work);
 }
 
-const executionTime = process.argv[2] || process.env.EXECUTION_TIME || 2
+const executionTime = process.argv[2] || process.env.EXECUTION_TIME_SEC || 2
 setTimeout(() => foo(executionTime), 100)

scenarios/php_allocations/Dockerfile

@@ -13,7 +13,7 @@ RUN ./install_profiler.sh
 COPY ./scenarios/php_allocations/main.php .
 RUN chmod 644 ./main.php
 
-ENV EXECUTION_TIME="10"
+ENV EXECUTION_TIME_SEC="10"
 ENV DD_PROFILING_OUTPUT_PPROF="/app/data/php.pprof"
 ENV DD_PROFILING_EXPERIMENTAL_ALLOCATION_ENABLED=true
 ENV DD_PROFILING_ENABLED=true

scenarios/php_allocations/main.php

@@ -12,7 +12,7 @@ function b()
 
 function main()
 {
-    $duration = $_ENV["EXECUTION_TIME"] ?? 10;
+    $duration = $_ENV["EXECUTION_TIME_SEC"] ?? 10;
     $end = microtime(true) + $duration;
     while (microtime(true) < $end) {
         $start = microtime(true);

scenarios/php_time/Dockerfile

@@ -13,7 +13,7 @@ RUN ./install_profiler.sh
 COPY ./scenarios/php_time/main.php .
 RUN chmod 644 ./main.php
 
-ENV EXECUTION_TIME="10"
+ENV EXECUTION_TIME_SEC="10"
 ENV DD_PROFILING_OUTPUT_PPROF="/app/data/php.pprof"
 ENV DD_PROFILING_EXPERIMENTAL_CPU_TIME_ENABLED=true
 ENV DD_PROFILING_EXPERIMENTAL_ALLOCATION_ENABLED=false

scenarios/php_time/main.php

@@ -19,7 +19,7 @@ function b() {
 }
 
 function main() {
-        $duration = $_ENV["EXECUTION_TIME"];
+        $duration = $_ENV["EXECUTION_TIME_SEC"];
         $end = microtime(true) + ($duration / 2);
         while (microtime(true) < $end) {
                 a();

scenarios/python_basic/Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.10
 
-ENV EXECUTION_TIME="2"
+ENV EXECUTION_TIME_SEC="2"
 ENV DD_PROFILING_ENABLED true
 ENV DD_TRACE_ENABLED false
 ENV DD_TRACE_DEBUG true

scenarios/python_basic/main.py

@@ -8,11 +8,11 @@ def target(n):
 
 
 if __name__ == "__main__":
-    execution_time = int(os.environ.get("EXECUTION_TIME", "2"))
+    EXECUTION_TIME_SEC = int(os.environ.get("EXECUTION_TIME_SEC", "2"))
 
-    t = Thread(target=target, args=(execution_time / 2,))
+    t = Thread(target=target, args=(EXECUTION_TIME_SEC / 2,))
     t.start()
 
-    target(execution_time)
+    target(EXECUTION_TIME_SEC)
 
     t.join()

scenarios/python_basic_gevent/Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.10
 
-ENV EXECUTION_TIME="2"
+ENV EXECUTION_TIME_SEC="2"
 ENV DD_PROFILING_ENABLED true
 ENV DD_TRACE_ENABLED false
 ENV DD_TRACE_DEBUG true

scenarios/python_basic_gevent/main.py

@@ -12,11 +12,11 @@ def target(n):
 
 
 if __name__ == "__main__":
-    execution_time = int(os.environ.get("EXECUTION_TIME", "2"))
+    EXECUTION_TIME_SEC = int(os.environ.get("EXECUTION_TIME_SEC", "2"))
 
-    t = Thread(target=target, args=(execution_time / 2,))
+    t = Thread(target=target, args=(EXECUTION_TIME_SEC / 2,))
     t.start()
 
-    target(execution_time)
+    target(EXECUTION_TIME_SEC)
 
     t.join()

scenarios/python_cpu/Dockerfile

@@ -0,0 +1,21 @@
+# Use an official Python runtime as a parent image
+FROM python:3.11
+
+# Set the working directory in the container
+WORKDIR /usr/src/app
+
+# Copy the current directory contents into the container at /app
+COPY ./scenarios/python_cpu/ /usr/src/app
+
+RUN chmod 644 /usr/src/app/main.py
+# Install any needed packages specified in requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
+
+ENV EXECUTION_TIME_SEC=10
+# Run your python script when the container launches
+ENV DD_PROFILING_ENABLED true
+ENV DD_TRACE_ENABLED false
+ENV DD_TRACE_DEBUG false
+ENV DD_PROFILING_OUTPUT_PPROF="/app/data/profiles"
+
+CMD ddtrace-run python main.py

scenarios/python_cpu/expected_profile.json

@@ -0,0 +1,36 @@
+{
+  "test_name": "python_cpu",
+  "stacks": [
+    {
+      "profile-type": "cpu-time",
+      "stack-content": [
+        {
+          "regular_expression": "\u003cmodule\u003e;main;b",
+          "percent": 66,
+          "error_margin": 5,
+          "labels": [
+            {
+              "key": "thread name",
+              "values": [
+                "MainThread"
+              ]
+            }
+          ]
+        },
+        {
+          "regular_expression": "\u003cmodule\u003e;main;a",
+          "percent": 33,
+          "error_margin": 6,
+          "labels": [
+            {
+              "key": "thread name",
+              "values": [
+                "MainThread"
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

scenarios/python_cpu/main.py

@@ -0,0 +1,31 @@
+import os
+from time import time
+
+x = 0
+i = 0
+
+def main():
+    global x, i
+    EXECUTION_TIME_SEC = int(os.getenv("EXECUTION_TIME_SEC", "10")) # defaults to 10 if not set
+    end = time() + EXECUTION_TIME_SEC
+    while time() < end:
+        a()
+        b()
+    # We add a print to prevent optimization that could turn this into a no-op program
+    print(x)
+
+def a():
+    global x, i
+    i = 0
+    while i < 1000000:
+        x += i
+        i += 1
+
+def b():
+    global x, i
+    i = 0
+    while i < 2000000:
+        x += i
+        i += 1
+
+main()

scenarios/python_cpu/requirements.txt

@@ -0,0 +1 @@
+ddtrace

scenarios/ruby_basic/main.rb

@@ -32,7 +32,7 @@ def b
 end
 
 test_duration = 50
-exec_time_env = ENV['EXECUTION_TIME']
+exec_time_env = ENV['EXECUTION_TIME_SEC']
 if exec_time_env
   test_duration = exec_time_env.to_i
   if test_duration == 0