Skip to main content

Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... ).

Project description

codecov Actions Actions

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
  • 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:

Installation

Installation is done using pip, the package installer for Python, in the following manner:

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:

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 to manage your dependencies and trigger tooling.
pip install poetry
  1. Installing dependencies from lock file
poetry install

Running formaters

poetry run black .

Running linters

poetry run flake8

Running tests

A test suite is provided, and can be run with:

$ tox

To run a specific test:

$ tox -- tests/test_redistimeseries.py

License

redisbench-admin is distributed under the BSD3 license - see LICENSE

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redisbench_admin-0.10.24.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

redisbench_admin-0.10.24-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

Details for the file redisbench_admin-0.10.24.tar.gz.

File metadata

  • Download URL: redisbench_admin-0.10.24.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.7 Linux/5.19.0-46-generic

File hashes

Hashes for redisbench_admin-0.10.24.tar.gz
Algorithm Hash digest
SHA256 63e7a089c08bc312390c509329ff617e2d62a775bfaa387910b71f171e8be003
MD5 d00403f9e19e24287372b02ae9e5ee22
BLAKE2b-256 891f0fead45d62ddae2dd7bea9cdcdadc9bc4604dfd7d69a8eeda16569a3bac8

See more details on using hashes here.

File details

Details for the file redisbench_admin-0.10.24-py3-none-any.whl.

File metadata

  • Download URL: redisbench_admin-0.10.24-py3-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.7 Linux/5.19.0-46-generic

File hashes

Hashes for redisbench_admin-0.10.24-py3-none-any.whl
Algorithm Hash digest
SHA256 1ffbc866ed7e867cfc6b6ada4a58d2ec3f600d109caff31ff416a913291ea463
MD5 8a19773a6f8781bcc8a3467d73dde139
BLAKE2b-256 12d5c7a29ea0f9bc96d7fec5ad3ec8ffbe9d5b8da5d1a336dd8fa5ff75345467

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page