Skip to content

Commit d124862

Browse files
Update readme org. Included new args on tool. Fixed release process (#20)
1 parent 74d3b85 commit d124862

File tree

2 files changed

+33
-20
lines changed

2 files changed

+33
-20
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
strategy:
1313
matrix:
14-
goos: [linux, darwin,windows]
14+
goos: [linux, darwin, windows]
1515
goarch: [amd64, arm64]
1616
steps:
1717
- uses: actions/checkout@v3
@@ -20,7 +20,7 @@ jobs:
2020
github_token: ${{ secrets.GITHUB_TOKEN }}
2121
goos: ${{ matrix.goos }}
2222
goarch: ${{ matrix.goarch }}
23-
binary_name: "./redis-benchmark-go"
23+
binary_name: "redis-benchmark-go"
2424
sha256sum: true
2525
asset_name: redis-benchmark-go-${{ matrix.goos }}-${{ matrix.goarch }}
2626
build_command: "make build"

README.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,23 @@ This repo contains code to mimic redis-benchmark capabilities in go.
1111

1212
If you don't have go on your machine and just want to use the produced binaries you can download the following prebuilt bins:
1313

14-
https://github.com/filipecosta90/redis-benchmark-go/releases/latest
14+
https://github.com/redis-performance/redis-benchmark-go/releases/latest
1515

1616
Here's how:
1717

1818
**Linux**
1919

2020
x86
2121
```
22-
wget -c https://github.com/filipecosta90/redis-benchmark-go/releases/latest/download/redis-benchmark-go-linux-amd64.tar.gz -O - | tar -xz
22+
wget -c https://github.com/redis-performance/redis-benchmark-go/releases/latest/download/redis-benchmark-go-linux-amd64.tar.gz -O - | tar -xz
2323
2424
# give it a try
2525
./redis-benchmark-go --help
2626
```
2727

2828
arm64
2929
```
30-
wget -c https://github.com/filipecosta90/redis-benchmark-go/releases/latest/download/redis-benchmark-go-linux-arm64.tar.gz -O - | tar -xz
30+
wget -c https://github.com/redis-performance/redis-benchmark-go/releases/latest/download/redis-benchmark-go-linux-arm64.tar.gz -O - | tar -xz
3131
3232
# give it a try
3333
./redis-benchmark-go --help
@@ -37,23 +37,23 @@ wget -c https://github.com/filipecosta90/redis-benchmark-go/releases/latest/down
3737

3838
x86
3939
```
40-
wget -c https://github.com/filipecosta90/redis-benchmark-go/releases/latest/download/redis-benchmark-go-darwin-amd64.tar.gz -O - | tar -xz
40+
wget -c https://github.com/redis-performance/redis-benchmark-go/releases/latest/download/redis-benchmark-go-darwin-amd64.tar.gz -O - | tar -xz
4141
4242
# give it a try
4343
./redis-benchmark-go --help
4444
```
4545

4646
arm64
4747
```
48-
wget -c https://github.com/filipecosta90/redis-benchmark-go/releases/latest/download/redis-benchmark-go-darwin-arm64.tar.gz -O - | tar -xz
48+
wget -c https://github.com/redis-performance/redis-benchmark-go/releases/latest/download/redis-benchmark-go-darwin-arm64.tar.gz -O - | tar -xz
4949
5050
# give it a try
5151
./redis-benchmark-go --help
5252
```
5353

5454
**Windows**
5555
```
56-
wget -c https://github.com/filipecosta90/redis-benchmark-go/releases/latest/download/redis-benchmark-go-windows-amd64.tar.gz -O - | tar -xz
56+
wget -c https://github.com/redis-performance/redis-benchmark-go/releases/latest/download/redis-benchmark-go-windows-amd64.tar.gz -O - | tar -xz
5757
5858
# give it a try
5959
./redis-benchmark-go --help
@@ -65,8 +65,8 @@ The easiest way to get and install the benchmark utility with a Go Env is to use
6565
`go get` and then `go install`:
6666
```bash
6767
# Fetch this repo
68-
go get github.com/filipecosta90/redis-benchmark-go
69-
cd $GOPATH/src/github.com/filipecosta90/redis-benchmark-go
68+
go get github.com/redis-performance/redis-benchmark-go
69+
cd $GOPATH/src/github.com/redis-performance/redis-benchmark-go
7070
make
7171
```
7272

@@ -76,24 +76,37 @@ make
7676
$ redis-benchmark-go --help
7777
Usage of redis-benchmark-go:
7878
-a string
79-
Password for Redis Auth.
79+
Password for Redis Auth.
8080
-c uint
81-
number of clients. (default 50)
81+
number of clients. (default 50)
8282
-d uint
83-
Data size of the expanded string __data__ value in bytes. The benchmark will expand the string __data__ inside an argument with a charset with length specified by this parameter. The substitution changes every time a command is executed. (default 3)
83+
Data size of the expanded string __data__ value in bytes. The benchmark will expand the string __data__ inside an argument with a charset with length specified by this parameter. The substitution changes every time a command is executed. (default 3)
8484
-debug int
85-
Client debug level.
85+
Client debug level.
8686
-h string
87-
Server hostname. (default "127.0.0.1")
88-
-l Loop. Run the tests forever.
87+
Server hostname. (default "127.0.0.1")
88+
-l Loop. Run the tests forever.
89+
-multi
90+
Run each command in multi-exec.
8991
-n uint
90-
Total number of requests (default 100000)
92+
Total number of requests (default 10000000)
93+
-oss-cluster
94+
Enable OSS cluster mode.
9195
-p int
92-
Server port. (default 12000)
96+
Server port. (default 12000)
9397
-r uint
94-
keyspace length. The benchmark will expand the string __key__ inside an argument with a number in the specified range from 0 to keyspacelen-1. The substitution changes every time a command is executed. (default 1000000)
98+
keyspace length. The benchmark will expand the string __key__ inside an argument with a number in the specified range from 0 to keyspacelen-1. The substitution changes every time a command is executed. (default 1000000)
9599
-random-seed int
96-
random seed to be used. (default 12345)
100+
random seed to be used. (default 12345)
101+
-resp int
102+
redis command response protocol (2 - RESP 2, 3 - RESP 3) (default 2)
103+
-rps int
104+
Max rps. If 0 no limit is applied and the DB is stressed up to maximum.
105+
-v Output version and exit
106+
-wait-replicas int
107+
If larger than 0 will wait for the specified number of replicas.
108+
-wait-replicas-timeout-ms int
109+
WAIT timeout when used together with -wait-replicas. (default 1000)
97110
```
98111

99112
## Sample output - Rate limited example. 1000 Keys, 100K commands, @10K RPS

0 commit comments

Comments
 (0)