This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-performance-tests.git
The following commit(s) were added to refs/heads/main by this push:
new f950296 Added some basic documentation about running these JMH tests
f950296 is described below
commit f95029672545f70a85d89869982791a71fc88738
Author: Otavio Rodolfo Piske <[email protected]>
AuthorDate: Wed Jul 16 14:18:40 2025 +0200
Added some basic documentation about running these JMH tests
---
README.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/README.md b/README.md
index 68dc051..d954173 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
# Apache Camel Performance Tests
This project provides performance tests for Apache Camel.
+
+## Running the Performance Tests
+
+### Camel JMH
+
+The performance tests located in the `camel-jmh` module can be run using the
following command:
+
+```bash
+mvn -l camel-${version}-jmh-test.log -DargLine="-XX:+UseNUMA -Xmx4G -Xms4G
-server" -Dcamel.version=${version} -Pjmh -Dtest=${TESTS} clean test
+```
+
+Where:
+* `${version}` is the Apache Camel version to use.
+* `${TESTS}` is a comma-separated list of tests to run (e.g.,
`AggregatorTest,ContentBasedRouterBodyTest`).
+
+After running the tests, the results are stored in JMH JSON files (i.e.:
`<test name>.jmh.json`).
