redisbench-admin 0.10.23__tar.gz → 0.10.25__tar.gz

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redisbench-admin
-Version: 0.10.23
+Version: 0.10.25
 Summary: Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... ).
 Author: filipecosta90
 Author-email: filipecosta.90@gmail.com

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.10.23"
+version = "0.10.25"
 description = "Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... )."
 authors = ["filipecosta90 <filipecosta.90@gmail.com>","Redis Performance Group <performance@redis.com>"]
 readme = "README.md"

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/redisbench_admin/run/common.py

@@ -699,6 +699,8 @@ def print_results_table_stdout(
     setup_name,
     test_name,
     cpu_usage=None,
+    kv_overall={},
+    metric_names=[],
 ):
     # check which metrics to extract
     (_, metrics,) = merge_default_and_config_metrics(
@@ -714,6 +716,11 @@ def print_results_table_stdout(
     results_matrix = extract_results_table(metrics, results_dict)
     if cpu_usage is not None:
         results_matrix.append(["Total shards CPU usage %", "", "", cpu_usage])
+    for metric_name in metric_names:
+        if metric_name in kv_overall:
+            metric_value = kv_overall[metric_name]
+            results_matrix.append([f"Total shards {metric_name}", "", "", metric_value])
+
     results_matrix = [[x[0], "{:.3f}".format(x[3])] for x in results_matrix]
     writer = MarkdownTableWriter(
         table_name=table_name,

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/redisbench_admin/run_local/args.py

@@ -8,13 +8,17 @@ import os
 from redisbench_admin.run.args import common_run_args
 from redisbench_admin.run.common import REDIS_BINARY
 
-FLUSHALL_AT_START = bool(int(os.getenv("FLUSHALL_AT_START", "0")))
+FLUSHALL_AT_START = bool(int(os.getenv("FLUSHALL_AT_START", "1")))
 IGNORE_KEYSPACE_ERRORS = bool(int(os.getenv("IGNORE_KEYSPACE_ERRORS", "0")))
+SKIP_REDIS_SPIN = bool(int(os.getenv("SKIP_REDIS_SPIN", "0")))
+REDIS_PORT = int(os.getenv("SKIP_REDIS_SPIN", "6379"))
+REDIS_HOST = os.getenv("REDIS_HOST", "127.0.0.1")
 
 
 def create_run_local_arguments(parser):
     parser = common_run_args(parser)
-    parser.add_argument("--port", type=int, default=6379)
+    parser.add_argument("--port", type=int, default=REDIS_PORT)
+    parser.add_argument("--host", type=str, default=REDIS_HOST)
     parser.add_argument("--redis-binary", type=str, default=REDIS_BINARY)
     parser.add_argument(
         "--flushall_on_every_test_start",
@@ -22,6 +26,12 @@ def create_run_local_arguments(parser):
         default=FLUSHALL_AT_START,
         help="At the start of every test send a FLUSHALL",
     )
+    parser.add_argument(
+        "--skip-redis-spin",
+        type=bool,
+        default=SKIP_REDIS_SPIN,
+        help="Skip redis spin. consider redis alive at host:port",
+    )
     parser.add_argument(
         "--ignore_keyspace_errors",
         type=bool,

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/redisbench_admin/run_local/local_db.py

@@ -79,84 +79,86 @@ def local_db_spin(
                 redis_processes,
             )
     else:
-        # setup Redis
-        # copy the rdb to DB machine
-        redis_7 = args.redis_7
-        logging.info(
-            "Using local temporary dir to spin up Redis Instance. Path: {}".format(
-                temporary_dir
-            )
-        )
-        if dbdir_folder is not None:
-            from distutils.dir_util import copy_tree
-
-            copy_tree(dbdir_folder, temporary_dir)
+        if args.skip_redis_spin is False:
+            # setup Redis
+            # copy the rdb to DB machine
+            redis_7 = args.redis_7
             logging.info(
-                "Copied entire content of {} into temporary path: {}".format(
-                    dbdir_folder, temporary_dir
+                "Using local temporary dir to spin up Redis Instance. Path: {}".format(
+                    temporary_dir
                 )
             )
-        (
-            _,
-            _,
-            redis_configuration_parameters,
-            dataset_load_timeout_secs,
-            modules_configuration_parameters_map,
-        ) = extract_redis_dbconfig_parameters(benchmark_config, "dbconfig")
+            if dbdir_folder is not None:
+                from distutils.dir_util import copy_tree
 
-        logging.info(
-            "Using a dataset load timeout of {} seconds.".format(
-                dataset_load_timeout_secs
-            )
-        )
-
-        if setup_type == "oss-cluster":
-            cluster_api_enabled = True
-            shard_host = "127.0.0.1"
-            redis_processes, redis_conns = spin_up_local_redis_cluster(
-                binary,
-                temporary_dir,
-                shard_count,
-                shard_host,
-                args.port,
-                local_module_file,
+                copy_tree(dbdir_folder, temporary_dir)
+                logging.info(
+                    "Copied entire content of {} into temporary path: {}".format(
+                        dbdir_folder, temporary_dir
+                    )
+                )
+            (
+                _,
+                _,
                 redis_configuration_parameters,
                 dataset_load_timeout_secs,
                 modules_configuration_parameters_map,
-                redis_7,
-            )
+            ) = extract_redis_dbconfig_parameters(benchmark_config, "dbconfig")
 
-            status = setup_redis_cluster_from_conns(
-                redis_conns, shard_count, shard_host, args.port
-            )
-            if status is False:
-                raise Exception("Redis cluster setup failed. Failing test.")
-
-        if setup_type == "oss-standalone":
-            redis_processes = spin_up_local_redis(
-                binary,
-                args.port,
-                temporary_dir,
-                local_module_file,
-                redis_configuration_parameters,
-                dbdir_folder,
-                dataset_load_timeout_secs,
-                modules_configuration_parameters_map,
-                redis_7,
+            logging.info(
+                "Using a dataset load timeout of {} seconds.".format(
+                    dataset_load_timeout_secs
+                )
             )
-        if setup_type == "oss-cluster":
-            for shardn, redis_process in enumerate(redis_processes):
-                logging.info(
-                    "Checking if shard #{} process with pid={} is alive".format(
-                        shardn + 1, redis_process.pid
-                    )
+
+            if setup_type == "oss-cluster":
+                cluster_api_enabled = True
+                redis_processes, redis_conns = spin_up_local_redis_cluster(
+                    binary,
+                    temporary_dir,
+                    shard_count,
+                    args.host,
+                    args.port,
+                    local_module_file,
+                    redis_configuration_parameters,
+                    dataset_load_timeout_secs,
+                    modules_configuration_parameters_map,
+                    redis_7,
+                )
+
+                status = setup_redis_cluster_from_conns(
+                    redis_conns, shard_count, args.host, args.port
+                )
+                if status is False:
+                    raise Exception("Redis cluster setup failed. Failing test.")
+
+            if setup_type == "oss-standalone":
+                redis_processes = spin_up_local_redis(
+                    binary,
+                    args.port,
+                    temporary_dir,
+                    local_module_file,
+                    redis_configuration_parameters,
+                    dbdir_folder,
+                    dataset_load_timeout_secs,
+                    modules_configuration_parameters_map,
+                    redis_7,
                 )
-                if is_process_alive(redis_process) is False:
-                    raise Exception("Redis process is not alive. Failing test.")
-            cluster_init_steps(clusterconfig, redis_conns, local_module_file)
+            if setup_type == "oss-cluster":
+                for shardn, redis_process in enumerate(redis_processes):
+                    logging.info(
+                        "Checking if shard #{} process with pid={} is alive".format(
+                            shardn + 1, redis_process.pid
+                        )
+                    )
+                    if is_process_alive(redis_process) is False:
+                        raise Exception("Redis process is not alive. Failing test.")
+                cluster_init_steps(clusterconfig, redis_conns, local_module_file)
+        else:
+            logging.info("Skipping DB spin step...")
 
     if setup_type == "oss-standalone":
-        r = redis.Redis(port=args.port)
+        r = redis.Redis(port=args.port, host=args.host)
         r.ping()
         r.client_setname("redisbench-admin-standalone")
         redis_conns.append(r)
@@ -184,7 +186,7 @@ def local_db_spin(
             benchmark_config,
             full_benchmark_path,
             args.port,
-            "localhost",
+            args.host,
             local_benchmark_output_filename,
             False,
             benchmark_tool_workdir,

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/redisbench_admin/run_local/run_local.py

@@ -29,8 +29,10 @@ from redisbench_admin.run.common import (
 )
 from redisbench_admin.run.metrics import (
     from_info_to_overall_shard_cpu,
+    collect_redis_metrics,
     collect_cpu_data,
 )
+
 from redisbench_admin.run.redistimeseries import (
     datasink_profile_tabular_data,
     timeseries_test_sucess_flow,
@@ -288,7 +290,7 @@ def run_local_command_logic(args, project_name, project_version):
                                     benchmark_config,
                                     full_benchmark_path,
                                     args.port,
-                                    "127.0.0.1",
+                                    args.host,
                                     local_benchmark_output_filename,
                                     False,
                                     benchmark_tool_workdir,
@@ -376,6 +378,21 @@ def run_local_command_logic(args, project_name, project_version):
                                     test_name,
                                 )
 
+                                (
+                                    end_time_ms,
+                                    _,
+                                    overall_end_time_metrics,
+                                ) = collect_redis_metrics(
+                                    redis_conns,
+                                    ["memory"],
+                                    {
+                                        "memory": [
+                                            "used_memory",
+                                            "used_memory_dataset",
+                                        ]
+                                    },
+                                )
+
                                 if (
                                     profilers_enabled
                                     and args.push_results_redistimeseries
@@ -413,6 +430,11 @@ def run_local_command_logic(args, project_name, project_version):
                                         setup_name,
                                         test_name,
                                         total_shards_cpu_usage,
+                                        overall_end_time_metrics,
+                                        [
+                                            "memory_used_memory",
+                                            "memory_used_memory_dataset",
+                                        ],
                                     )
 
                                     # check KPIs

{redisbench_admin-0.10.23 → redisbench_admin-0.10.25}/setup.py

@@ -82,7 +82,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'redisbench-admin',
-    'version': '0.10.23',
+    'version': '0.10.25',
     'description': 'Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... ).',
     'long_description': '[![codecov](https://codecov.io/gh/redis-performance/redisbench-admin/branch/master/graph/badge.svg)](https://codecov.io/gh/redis-performance/redisbench-admin)\n![Actions](https://github.com/redis-performance/redisbench-admin/workflows/Run%20Tests/badge.svg?branch=master)\n![Actions](https://badge.fury.io/py/redisbench-admin.svg)\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\n## License\n\nredisbench-admin is distributed under the BSD3 license - see [LICENSE](LICENSE)\n',
     'author': 'filipecosta90',