Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redislabs/pubsub-sub-bench
Redis Pub/Sub Subscriber Workload generator
https://github.com/redislabs/pubsub-sub-bench
pubsub redis
Last synced: about 1 month ago
JSON representation
Redis Pub/Sub Subscriber Workload generator
- Host: GitHub
- URL: https://github.com/redislabs/pubsub-sub-bench
- Owner: RedisLabs
- License: bsd-2-clause
- Created: 2020-09-24T11:01:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T12:22:08.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T04:42:27.417Z (6 months ago)
- Topics: pubsub, redis
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 3
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Overview
When benchmarking a Pub/Sub Systems, we specifically require two distinct roles ( publishers and subscribers ) as benchmark participants - this repo contains code to mimic the subscriber workload on Redis Pub/Sub.
Several aspects can dictate the overall system performance, like the:
- Payload size (controlled on publisher)
- Number of Pub/Sub channels (controlled on publisher)
- Total message traffic per channel (controlled on publisher)
- Number of subscribers per channel (controlled on subscriber)
- Subscriber distribution per shard and channel (controlled on subscriber)
## Getting Started
### Installing
This benchmark go program is **know to be supported for go >= 1.11**.
The easiest way to get and install the Subscriber Go program is to use `go get` and then `go install`:
```
go get github.com/RedisLabs/pubsub-sub-bench
cd $GOPATH/src/github.com/RedisLabs/pubsub-sub-bench
make
```
#### Updating
To update the Subscriber Go program use `go get -u` to retrieve the latest version:.
```
go get -u github.com/RedisLabs/pubsub-sub-bench
cd $GOPATH/src/github.com/RedisLabs/pubsub-sub-bench
make
```
#### Limitations
There are know limitations on old go version due to the radix/v3 dependency, given that on old versions,
the go command in GOPATH mode does not distinguish between major versions, meaning that it will look for the package `package github.com/mediocregopher/radix/v3` instead of v3 of `package github.com/mediocregopher/radix`.
Therefore you should only use this tool on go >= 1.11.
## Usage of pubsub-sub-bench
```
Usage of pubsub-sub-bench:
-channel-maximum int
channel ID maximum value ( each channel has a dedicated thread ). (default 100)
-channel-minimum int
channel ID minimum value ( each channel has a dedicated thread ). (default 1)
-client-output-buffer-limit-pubsub string
Specify client output buffer limits for clients subscribed to at least one pubsub channel or pattern. If the value specified is different that the one present on the DB, this setting will apply.
-client-update-tick int
client update tick. (default 1)
-host string
redis host. (default "127.0.0.1")
-json-out-file string
Name of json output file, if not set, will not print to json.
-messages int
Number of total messages per subscriber per channel.
-oss-cluster-api-distribute-subscribers
read cluster slots and distribute subscribers among them.
-port string
redis port. (default "6379")
-print-messages
print messages.
-subscriber-prefix string
prefix for subscribing to channel, used in conjunction with key-minimum and key-maximum. (default "channel-")
-subscribers-per-channel int
number of subscribers per channel. (default 1)
-subscribers-placement-per-channel string
(dense,sparse) dense - Place all subscribers to channel in a specific shard. sparse- spread the subscribers across as many shards possible, in a round-robin manner. (default "dense")
-test-time int
Number of seconds to run the test, after receiving the first message.
```