pnowojski commented on a change in pull request #41:
URL: https://github.com/apache/flink-benchmarks/pull/41#discussion_r782188954
##########
File path: README.md
##########
@@ -31,14 +31,38 @@ There're mainly two ways:
mvn -Dflink.version=<FLINK_VERSION> clean package exec:exec \
-Dbenchmarks="<benchmark_class>"
```
-An example flink version can be -Dflink.version=1.12-SNAPSHOT.
+
+ An example flink version can be -Dflink.version=1.12-SNAPSHOT.
+
+3. Run the uber jar directly like:
+
+ ```
+ java -jar target/benchmarks.jar -rf csv "<benchmark_class>"
+ ```
We also support to run each benchmark once (with only one fork and one
iteration) for testing, with below command:
```
mvn test -P test
```
+## Parameters
+
+There are some built-in parameters to run different benchmarks, these can be
shown/overridden from the command line.
+
+```
+# show all the parameters combination for the <benchmark_class>
+java -jar target/benchmarks.jar "<benchmark_class>" -lp
+
+# run benchmark for rocksdb state backend type
+java -jar target/benchmarks.jar "org.apache.flink.state.benchmark.*" -p
"backendType=ROCKSDB"
+```
+
+## Configuration
+
+Besides the parameters, there also provides a benchmark config file
`benchmark-conf.yaml` to tune some basic config.
+For example, we can change the state data dir by put
`benchmark.state.data-dir: /data` in config file. For more options, you can
refer to the code in `org.apache.flink.config` package.
Review comment:
```suggestion
For example, we can change the state data dir by putting
`benchmark.state.data-dir: /data` in the config file. For more options, you can
refer to the code in the `org.apache.flink.config` package.
```
##########
File path: README.md
##########
@@ -31,14 +31,38 @@ There're mainly two ways:
mvn -Dflink.version=<FLINK_VERSION> clean package exec:exec \
-Dbenchmarks="<benchmark_class>"
```
-An example flink version can be -Dflink.version=1.12-SNAPSHOT.
+
+ An example flink version can be -Dflink.version=1.12-SNAPSHOT.
+
+3. Run the uber jar directly like:
+
+ ```
+ java -jar target/benchmarks.jar -rf csv "<benchmark_class>"
+ ```
We also support to run each benchmark once (with only one fork and one
iteration) for testing, with below command:
```
mvn test -P test
```
+## Parameters
+
+There are some built-in parameters to run different benchmarks, these can be
shown/overridden from the command line.
+
+```
+# show all the parameters combination for the <benchmark_class>
+java -jar target/benchmarks.jar "<benchmark_class>" -lp
+
+# run benchmark for rocksdb state backend type
+java -jar target/benchmarks.jar "org.apache.flink.state.benchmark.*" -p
"backendType=ROCKSDB"
+```
+
+## Configuration
+
+Besides the parameters, there also provides a benchmark config file
`benchmark-conf.yaml` to tune some basic config.
Review comment:
```suggestion
Besides the parameters, there is also a benchmark config file
`benchmark-conf.yaml` to tune some basic parameters.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
