update benchmark

Signed-off-by: Gregor Zeitlinger <[email protected]>

Author: zeitlinger

.mise/tasks/test_run_benchmarks.py .mise/tasks/test_update-benchmarks.py.mise/tasks/test_run_benchmarks.py renamed to .mise/tasks/test_update-benchmarks.py

@@ -9,7 +9,7 @@
 if here not in sys.path:
     sys.path.insert(0, here)
 
-from run_benchmarks import update_pre_blocks_under_module
+from update_benchmarks import update_pre_blocks_under_module
 
 
 class TestRunBenchmarksFiltering(unittest.TestCase):

.mise/tasks/run-benchmarks.py .mise/tasks/update_benchmarks.py.mise/tasks/run-benchmarks.py renamed to .mise/tasks/update_benchmarks.py

@@ -1,13 +1,14 @@
 #!/usr/bin/env python3
 
 #MISE description="Run and update JMH benchmark outputs in the benchmarks module"
+#MISE alias="update-benchmarks"
 
 """
 Run benchmarks for the `benchmarks` module, capture JMH text output, and update
 any <pre>...</pre> blocks containing "thrpt" under the `benchmarks/` module
 (files such as Java sources with embedded example output in javadocs).
 
-Usage: ./scripts/run_benchmarks.py [--mvnw ./mvnw] [--module benchmarks] [--java java] [--jmh-args "-f 1 -wi 0 -i 1"]
+Usage: ./scripts/update_benchmarks.py [--mvnw ./mvnw] [--module benchmarks] [--java java] [--jmh-args "-f 1 -wi 0 -i 1"]
 
 By default this will:
  - run the maven wrapper to package the benchmarks: `./mvnw -pl benchmarks -am -DskipTests package`

benchmarks/README.md

@@ -7,7 +7,7 @@
 Run benchmarks and update the results in the Javadoc of the benchmark classes:
 
 ```shell
-mise run run-benchmarks
+mise run update-benchmarks
 ``` 
 
 ### Running benchmarks manually
@@ -26,8 +26,9 @@ java -jar ./benchmarks/target/benchmarks.jar CounterBenchmark
 
 See Javadoc of the benchmark classes:
 
-- [CounterBenchmark](https://github.com/prometheus/client_java/blob/1.0.x/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/CounterBenchmark.java) <!-- editorconfig-checker-disable-line -->
-- [HistogramBenchmark](https://github.com/prometheus/client_java/blob/1.0.x/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/HistogramBenchmark.java) <!-- editorconfig-checker-disable-line -->
+- [CounterBenchmark](https://github.com/prometheus/client_java/blob/main/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/CounterBenchmark.java) <!-- editorconfig-checker-disable-line -->
+- [HistogramBenchmark](https://github.com/prometheus/client_java/blob/main/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/HistogramBenchmark.java) <!-- editorconfig-checker-disable-line -->
+- [TextFormatUtilBenchmark](https://github.com/prometheus/client_java/blob/main/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/TextFormatUtilBenchmark.java)  <!-- editorconfig-checker-disable-line -->
 
 ## What Prometheus Java client optimizes for
 
@@ -41,6 +42,14 @@ Prometheus client Java metrics support concurrent updates and scrapes. This show
 multiple threads recording data in shared
 metrics.
 
+## Test the benchmark creation script
+                                              
+To test the benchmark creation script, run:
+
+```shell
+python ./.mise/tasks/test_update-benchmarks.py
+```
+
 ## Archive
 
 The `src/main/archive/` directory contains the old benchmarks from 0.16.0 and earlier. It will be