Skip to content

Commit 27d3e12

Browse files
Artem LabazinArtem Labazin
authored andcommitted
Update benchmark doc
1 parent 30ff973 commit 27d3e12

File tree

1 file changed

+47
-8
lines changed

1 file changed

+47
-8
lines changed

benchmark/README.md

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44

55
* **JMH version:** 1.21
66

7-
* **VM version:** JDK 1.8.0_161, Java HotSpot(TM) 64-Bit Server VM, 25.161-b12
7+
* **VM version:** JDK 1.8.0_181, Java HotSpot(TM) 64-Bit Server VM, 25.181-b13
88

9-
* **VM options:** <none>
9+
* **VM options:** -Xms1G -Xmx2G
1010

11-
* **Warmup:** 5 iterations, 10 s each
11+
* **Warmup:** 10 iterations, 10 s each
1212

13-
* **Measurement:** 5 iterations, 10 s each
13+
* **Measurement:** 20 iterations, 10 s each
1414

1515
* **Timeout:** 10 min per iteration
1616

1717
* **Threads:** 1 thread, will synchronize iterations
1818

1919
* **Benchmark mode:** Throughput, ops/time
2020

21-
## Results
21+
## The results
2222

2323
| Benchmark | Mode | Cnt | Score | Error | Units |
2424
|----------------------------------------------------------------------------------------------------------------|-------|-----|------------:|------------:|-------|
@@ -29,7 +29,41 @@
2929
| [JInterfaceBenchmark.node2node](./src/main/java/io/appulse/encon/benchmark/JInterfaceBenchmark.java#L175) | thrpt | 25 | 13850.978 | ± 126.660 | ops/s |
3030
| [JInterfaceBenchmark.oneDirection](./src/main/java/io/appulse/encon/benchmark/JInterfaceBenchmark.java#L165) | thrpt | 25 | 27590.545 | ± 253.874 | ops/s |
3131

32-
How to run the benchmarks:
32+
## How to setup the environment
33+
34+
1. Add Java repository:
35+
36+
```bash
37+
$> sudo add-apt-repository ppa:webupd8team/java
38+
```
39+
40+
2. Update and upgrade the distro:
41+
42+
```bash
43+
$> sudo apt-get update && sudo apt-get upgrade
44+
```
45+
46+
3. Install `Git`, `Java 8` and `Maven`:
47+
48+
```bash
49+
$> sudo apt-get install oracle-java8-installer git maven
50+
```
51+
52+
4. Clone the repo:
53+
54+
```bash
55+
$> git clone https://github.com/appulse-projects/encon-java.git
56+
```
57+
58+
## How to run the benchmarks
59+
60+
1. Go to the project's root:
61+
62+
```bash
63+
$> cd encon-java
64+
```
65+
66+
2. Build the project with only needed dependencies:
3367

3468
```bash
3569
$> mvn clean package \
@@ -39,6 +73,11 @@ $> mvn clean package \
3973
-Dpmd.skip=true \
4074
-Dcheckstyle.skip \
4175
-Dmaven.test.skip=true \
42-
-pl benchmark -am; and \
43-
java -Xms1G -Xmx2G -jar benchmark/target/benchmarks.jar
76+
-pl benchmark -am
77+
```
78+
79+
3. Run the tests
80+
81+
```bash
82+
$> nohup java -Xms1G -Xmx2G -jar benchmark/target/benchmarks.jar > job.logs 2>&1 &
4483
```

0 commit comments

Comments
 (0)