From 54ec3046b48f93f4c79731e7d6df21fae9f38d43 Mon Sep 17 00:00:00 2001
From: Todd Baert <todd.baert@dynatrace.com>
Date: Thu, 10 Oct 2024 11:23:09 -0400
Subject: [PATCH] fixup: comments

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
---
 .../openfeature/sdk/benchmark/AllocationBenchmark.java   | 9 ++++++++-
 .../openfeature/sdk/benchmark/AllocationProfiler.java    | 4 ++++
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/test/java/dev/openfeature/sdk/benchmark/AllocationBenchmark.java b/src/test/java/dev/openfeature/sdk/benchmark/AllocationBenchmark.java
index 8034eb6e7..2e9544d55 100644
--- a/src/test/java/dev/openfeature/sdk/benchmark/AllocationBenchmark.java
+++ b/src/test/java/dev/openfeature/sdk/benchmark/AllocationBenchmark.java
@@ -26,8 +26,15 @@
 import dev.openfeature.sdk.OpenFeatureAPI;
 import dev.openfeature.sdk.Value;
 
+/**
+ * Runs a large volume of flag evaluations on a VM with 1G memory and GC
+ * completely disabled so we can take a heap-dump.
+ */
 public class AllocationBenchmark {
 
+    // 10K iterations works well with Xmx1024m (we don't want to run out of memory)
+    private static final int ITERATIONS = 10000;
+
     @Benchmark
     @Warmup(iterations = 0)
     @Measurement(iterations = 1)
@@ -44,7 +51,7 @@ public Optional<EvaluationContext> before(HookContext<Object> ctx, Map<String, O
             }
         });
 
-        for (int i = 0; i < 10000; i++) {
+        for (int i = 0; i < ITERATIONS; i++) {
             client.getBooleanValue(BOOLEAN_FLAG_KEY, false);
             client.getStringValue(STRING_FLAG_KEY, "default");
             client.getIntegerValue(INT_FLAG_KEY, 0);
diff --git a/src/test/java/dev/openfeature/sdk/benchmark/AllocationProfiler.java b/src/test/java/dev/openfeature/sdk/benchmark/AllocationProfiler.java
index 2725c85f6..8051a167e 100644
--- a/src/test/java/dev/openfeature/sdk/benchmark/AllocationProfiler.java
+++ b/src/test/java/dev/openfeature/sdk/benchmark/AllocationProfiler.java
@@ -18,6 +18,10 @@
 import org.openjdk.jmh.results.ScalarResult;
 import org.openjdk.jmh.util.Utils;
 
+/**
+ * Takes a heap dump (using JMAP from a separate process) after a benchmark;
+ * only useful if GC is disabled during the benchmark.
+ */
 public class AllocationProfiler implements InternalProfiler {
 
     public static class AllocationTotals {