| Name | redisbench-admin JSON |
| Version |
0.11.12
JSON |
| download |
| home_page | None |
| Summary | Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... ). |
| upload_time | 2024-09-18 19:45:36 |
| maintainer | None |
| docs_url | None |
| author | filipecosta90 |
| requires_python | <4.0.0,>=3.9.0 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://codecov.io/gh/redis-performance/redisbench-admin)
# [redisbench-admin](https://github.com/redis-performance/redisbench-admin)
Redis benchmark run helper can help you with the following tasks:
- Setup abd teardown of benchmarking infrastructure specified
on [redis-performance/testing-infrastructure](https://github.com/redis-performance/testing-infrastructure)
- Setup and teardown of an Redis and Redis Modules DBs for benchmarking
- Management of benchmark data and specifications across different setups
- Running benchmarks and recording results
- Exporting performance results in several formats (CSV, RedisTimeSeries, JSON)
- Finding on-cpu, off-cpu, io, and threading performance problems by attaching profiling tools/probers ( perf (a.k.a. perf_events), bpf tooling, vtune )
- **[SOON]** Finding performance problems by attaching telemetry probes
Current supported benchmark tools:
- [redis-benchmark](https://github.com/redis/redis)
- [memtier_benchmark](https://github.com/RedisLabs/memtier_benchmark)
- [redis-benchmark-go](https://github.com/redis-performance/redis-benchmark-go)
- [YCSB](https://github.com/RediSearch/YCSB)
- [tsbs](https://github.com/RedisTimeSeries/tsbs)
- [redisgraph-benchmark-go](https://github.com/RedisGraph/redisgraph-benchmark-go)
- [ftsb_redisearch](https://github.com/RediSearch/ftsb)
- [ann-benchmarks](https://github.com/RedisAI/ann-benchmarks)
## Installation
Installation is done using pip, the package installer for Python, in the following manner:
```bash
python3 -m pip install redisbench-admin
```
## Profiler daemon
You can use the profiler daemon by itself in the following manner.
On the target machine do as follow:
```bash
pip3 install --upgrade pip
pip3 install redisbench-admin --ignore-installed PyYAML
# install perf
apt install linux-tools-common linux-tools-generic linux-tools-`uname -r` -y
# ensure perf is working
perf --version
# install awscli
snap install aws-cli --classic
# configure aws
aws configure
# start the perf-daemon
perf-daemon start
WARNING:root:Unable to detected github_actor. caught the following error: No section: 'user'
Writting log to /tmp/perf-daemon.log
Starting perf-daemon. PID file /tmp/perfdaemon.pid. Daemon workdir: /root/RedisGraph
# check daemon is working appropriatelly
curl localhost:5000/ping
# start a profile
curl -X POST localhost:5000/profiler/perf/start/<pid to profile>
# stop a profile
curl -X POST -d '{"aws_access_key_id":$AWS_ACCESS_KEY_ID,"aws_secret_access_key":$AWS_SECRET_ACCESS_KEY}' localhost:5000/profiler/perf/stop/<pid to profile>
```
## Development
1. Install [pypoetry](https://python-poetry.org/) to manage your dependencies and trigger tooling.
```sh
pip install poetry
```
2. Installing dependencies from lock file
```
poetry install
```
### Running formaters
```sh
poetry run black .
```
### Running linters
```sh
poetry run flake8
```
### Running tests
A test suite is provided, and can be run with:
```sh
$ tox
```
To run a specific test:
```sh
$ tox -- tests/test_redistimeseries.py
```
To run a specific test with verbose logging:
```sh
# tox -- -vv --log-cli-level=INFO tests/test_run.py
```
## License
redisbench-admin is distributed under the BSD3 license - see [LICENSE](LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "redisbench-admin",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": "filipecosta90",
"author_email": "filipecosta.90@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c6/94/6158b676a101171f9d68d4c3d60cdec5ab5ce2694484fd230af7e6dbacc9/redisbench_admin-0.11.12.tar.gz",
"platform": null,
"description": "[](https://codecov.io/gh/redis-performance/redisbench-admin)\n\n\n\n# [redisbench-admin](https://github.com/redis-performance/redisbench-admin)\n\nRedis benchmark run helper can help you with the following tasks:\n\n- Setup abd teardown of benchmarking infrastructure specified\n on [redis-performance/testing-infrastructure](https://github.com/redis-performance/testing-infrastructure)\n- Setup and teardown of an Redis and Redis Modules DBs for benchmarking\n- Management of benchmark data and specifications across different setups\n- Running benchmarks and recording results\n- Exporting performance results in several formats (CSV, RedisTimeSeries, JSON)\n- Finding on-cpu, off-cpu, io, and threading performance problems by attaching profiling tools/probers ( perf (a.k.a. perf_events), bpf tooling, vtune )\n- **[SOON]** Finding performance problems by attaching telemetry probes\n\nCurrent supported benchmark tools:\n\n- [redis-benchmark](https://github.com/redis/redis)\n- [memtier_benchmark](https://github.com/RedisLabs/memtier_benchmark)\n- [redis-benchmark-go](https://github.com/redis-performance/redis-benchmark-go)\n- [YCSB](https://github.com/RediSearch/YCSB)\n- [tsbs](https://github.com/RedisTimeSeries/tsbs)\n- [redisgraph-benchmark-go](https://github.com/RedisGraph/redisgraph-benchmark-go)\n- [ftsb_redisearch](https://github.com/RediSearch/ftsb)\n- [ann-benchmarks](https://github.com/RedisAI/ann-benchmarks)\n\n## Installation\n\nInstallation is done using pip, the package installer for Python, in the following manner:\n\n```bash\npython3 -m pip install redisbench-admin\n```\n\n## Profiler daemon\n\nYou can use the profiler daemon by itself in the following manner. \nOn the target machine do as follow:\n\n```bash\npip3 install --upgrade pip\npip3 install redisbench-admin --ignore-installed PyYAML\n\n# install perf\napt install linux-tools-common linux-tools-generic linux-tools-`uname -r` -y\n\n# ensure perf is working\nperf --version\n\n# install awscli\nsnap install aws-cli --classic\n\n\n# configure aws\naws configure\n\n# start the perf-daemon\nperf-daemon start\nWARNING:root:Unable to detected github_actor. caught the following error: No section: 'user'\nWritting log to /tmp/perf-daemon.log\nStarting perf-daemon. PID file /tmp/perfdaemon.pid. Daemon workdir: /root/RedisGraph\n\n# check daemon is working appropriatelly\ncurl localhost:5000/ping\n\n# start a profile\ncurl -X POST localhost:5000/profiler/perf/start/<pid to profile>\n\n# stop a profile\ncurl -X POST -d '{\"aws_access_key_id\":$AWS_ACCESS_KEY_ID,\"aws_secret_access_key\":$AWS_SECRET_ACCESS_KEY}' localhost:5000/profiler/perf/stop/<pid to profile>\n```\n\n\n## Development\n\n1. Install [pypoetry](https://python-poetry.org/) to manage your dependencies and trigger tooling.\n```sh\npip install poetry\n```\n\n2. Installing dependencies from lock file\n\n```\npoetry install\n```\n\n### Running formaters\n\n```sh\npoetry run black .\n```\n\n\n### Running linters\n\n```sh\npoetry run flake8\n```\n\n\n### Running tests\n\nA test suite is provided, and can be run with:\n\n```sh\n$ tox\n```\n\nTo run a specific test:\n```sh\n$ tox -- tests/test_redistimeseries.py\n```\n\nTo run a specific test with verbose logging:\n\n```sh\n# tox -- -vv --log-cli-level=INFO tests/test_run.py\n```\n\n## License\n\nredisbench-admin is distributed under the BSD3 license - see [LICENSE](LICENSE)\n",
"bugtrack_url": null,
"license": null,
"summary": "Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... ).",
"version": "0.11.12",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7efb902ae165d3e39279a9b4ef6fb1d422cbffdbf56a2522c8baeddc100f3849",
"md5": "1c0a68d4d5033186e7814fce5568d475",
"sha256": "f1a2dab9d85e685360b7a3d146eeac7ab77eeebece850eb1bc6a686d563d336e"
},
"downloads": -1,
"filename": "redisbench_admin-0.11.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c0a68d4d5033186e7814fce5568d475",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 1837763,
"upload_time": "2024-09-18T19:45:32",
"upload_time_iso_8601": "2024-09-18T19:45:32.991438Z",
"url": "https://files.pythonhosted.org/packages/7e/fb/902ae165d3e39279a9b4ef6fb1d422cbffdbf56a2522c8baeddc100f3849/redisbench_admin-0.11.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6946158b676a101171f9d68d4c3d60cdec5ab5ce2694484fd230af7e6dbacc9",
"md5": "3080ad48d7cad73068fadf3ba71020c5",
"sha256": "afb48ad3b6f910dcdd1dcd58c2cd63093604facc8c9f374c0ccf630ba275bc53"
},
"downloads": -1,
"filename": "redisbench_admin-0.11.12.tar.gz",
"has_sig": false,
"md5_digest": "3080ad48d7cad73068fadf3ba71020c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.0",
"size": 1753131,
"upload_time": "2024-09-18T19:45:36",
"upload_time_iso_8601": "2024-09-18T19:45:36.226389Z",
"url": "https://files.pythonhosted.org/packages/c6/94/6158b676a101171f9d68d4c3d60cdec5ab5ce2694484fd230af7e6dbacc9/redisbench_admin-0.11.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 19:45:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "redisbench-admin"
}
