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.25.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.25-py3-none-any.whl (1.8 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: redisbench_admin-0.10.25.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.25.tar.gz
Algorithm Hash digest
SHA256 c83c96990770a19186144badfa936a77e1a669c8b80ef5abb988af25cca8145c
MD5 5ed6918424258b95551ba030810abc91
BLAKE2b-256 165cc4e7eb16bb27d85a8840949b4da7c42f2df22bb1e7afb4084b616162b3ea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: redisbench_admin-0.10.25-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.25-py3-none-any.whl
Algorithm Hash digest
SHA256 3dceb306184e9ce2ea05ed54bae011948d3607e79d1d09256a26df348f8f6579
MD5 57d62b15f539c7443f340a2152fe6e52
BLAKE2b-256 107b13fb2f996807455f11f285bdafb43f8428136c88adf77bfb9d24b213df57

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