Skip to content

Commit abc4e45

Browse files
markovamariamarkovamaria
committed
Moved Install and Execute sections to Contribution part
1 parent 948c424 commit abc4e45

File tree

1 file changed

+68
-42
lines changed

1 file changed

+68
-42
lines changed

‎Readme.md

Lines changed: 68 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,6 @@
66
[![PyPI version](https://badge.fury.io/py/redis-benchmarks-specification.svg)](https://pypi.org/project/redis-benchmarks-specification)
77

88

9-
## Installation
10-
11-
To have access to the latest SPEC and Tooling impletamtion you only need to install one python package.
12-
13-
Installation is done using pip, the package installer for Python, in the following manner:
14-
15-
```bash
16-
python3 -m pip install redis-benchmarks-specification --ignore-installed PyYAML
17-
```
18-
19-
## Execution
20-
redis-benchmarks-specificaiton should be run together with redis-server in the same time.
21-
22-
```bash
23-
# Run redis server
24-
./src/redis-server --port 6379 --dir logs --logfile server.log --save "" [--daemonize yes]
25-
26-
# Run benchmark
27-
redis-benchmarks-spec-client-runner --db_server_host localhost --db_server_port 6379 --client_aggregated_results_folder ./test
28-
```
29-
30-
Option "--daemonize yes" given to server run command allows to run redis-server in background.<br />
31-
Option "--test X.yml" given to benchmark execution command allows to run particular test, where X - test name
32-
33-
349
## Benchmark specifications goal
3510

3611
The Redis benchmarks specification describes the cross-language/tools requirements and expectations to foster performance and observability standards around redis related technologies.
@@ -64,24 +39,7 @@ This repo aims to provide Redis related benchmark standards and methodologies fo
6439
Current supported benchmark tools:
6540

6641
- [redis-benchmark](https://github.com/redis/redis)
67-
- [memtier_benchmark](https://github.com/RedisLabs/memtier_benchmark)
68-
- [SOON][redis-benchmark-go](https://github.com/filipecosta90/redis-benchmark-go)
69-
70-
71-
## Installing Redis benchmarks specification implementations
72-
73-
The Redis benchmarks specification and implementations is developed for Unix and is actively tested on it.
7442

75-
Installation is done using pip, the package installer for Python, in the following manner:
76-
77-
```bash
78-
python3 -m pip install redis-benchmarks-specification
79-
```
80-
81-
To run particular version - use its number, e.g. 0.1.57:
82-
```bash
83-
pip3 install redis-benchmarks-specification==0.1.57
84-
```
8543

8644
## Architecture diagram
8745

@@ -166,6 +124,74 @@ python3 -m pip install redis-benchmarks-specification --ignore-installed PyYAML
166124
```
167125

168126

127+
- [memtier_benchmark](https://github.com/RedisLabs/memtier_benchmark)
128+
- [SOON][redis-benchmark-go](https://github.com/filipecosta90/redis-benchmark-go)
129+
130+
131+
##### Installing Redis benchmarks specification implementations
132+
133+
To have access to the latest SPEC and Tooling impletamtion you only need to install one python package.<br />
134+
Installation is done using pip, the package installer for Python, in the following manner:
135+
136+
```bash
137+
python3 -m pip install redis-benchmarks-specification --ignore-installed PyYAML
138+
```
139+
140+
To run particular version - use its number, e.g. 0.1.57:
141+
```bash
142+
pip3 install redis-benchmarks-specification==0.1.57
143+
```
144+
145+
146+
##### Testing out the redis-benchmarks-spec-runner
147+
148+
There is am option to run "redis-benchmarks-spec" tests using standalone runner approach. For this option redis-benchmarks-specificaiton should be run together with redis-server in the same time.
149+
150+
```bash
151+
# Run redis server
152+
./src/redis-server --port 6379 --dir logs --logfile server.log --save "" [--daemonize yes]
153+
154+
# Run benchmark
155+
redis-benchmarks-spec-client-runner --db_server_host localhost --db_server_port 6379 --client_aggregated_results_folder ./test
156+
```
157+
158+
Option "--daemonize yes" given to server run command allows to run redis-server in background.<br />
159+
Option "--test X.yml" given to benchmark execution command allows to run particular test, where X - test name
160+
161+
Full list of option can be taken with "-h" option:
162+
```
163+
$ redis-benchmarks-spec-client-runner -h
164+
usage: redis-benchmarks-spec-client-runner [-h]
165+
[--platform-name PLATFORM_NAME]
166+
[--triggering_env TRIGGERING_ENV]
167+
[--setup_type SETUP_TYPE]
168+
[--github_repo GITHUB_REPO]
169+
[--github_org GITHUB_ORG]
170+
[--github_version GITHUB_VERSION]
171+
[--logname LOGNAME]
172+
[--test-suites-folder TEST_SUITES_FOLDER]
173+
[--test TEST]
174+
[--db_server_host DB_SERVER_HOST]
175+
[--db_server_port DB_SERVER_PORT]
176+
[--cpuset_start_pos CPUSET_START_POS]
177+
[--datasink_redistimeseries_host DATASINK_REDISTIMESERIES_HOST]
178+
[--datasink_redistimeseries_port DATASINK_REDISTIMESERIES_PORT]
179+
[--datasink_redistimeseries_pass DATASINK_REDISTIMESERIES_PASS]
180+
[--datasink_redistimeseries_user DATASINK_REDISTIMESERIES_USER]
181+
[--datasink_push_results_redistimeseries] [--profilers PROFILERS]
182+
[--enable-profilers] [--flushall_on_every_test_start]
183+
[--flushall_on_every_test_end]
184+
[--preserve_temporary_client_dirs]
185+
[--client_aggregated_results_folder CLIENT_AGGREGATED_RESULTS_FOLDER]
186+
[--tls]
187+
[--tls-skip-verify]
188+
[--cert CERT]
189+
[--key KEY]
190+
[--cacert CACERT]
191+
redis-benchmarks-spec-client-runner (solely client) 0.1.61
192+
...
193+
```
194+
169195
##### Testing out redis-benchmarks-spec-sc-coordinator
170196

171197
You should now be able to print the following installed benchmark runner help:

0 commit comments

Comments
 (0)