Onboard KVrocks Memtier benchmark.

PiperOrigin-RevId: 815736286

Author: p3rf Team

CHANGES.next.md

@@ -257,6 +257,7 @@
 -   Add support for the `--addons` flag in GKE Standard.
 -   Add support for RHEL and Rocky Linux 10.
 -   Add support for Debian 13.
+-   Add KVRocks memtier benchmark with LSSD support.
 
 ### Enhancements:
 

perfkitbenchmarker/configs/default_benchmark_config.yaml

@@ -567,3 +567,21 @@ diskspd_max_throughput_write_only:
   flags:
     <<: *diskspd_write_only_flags
     <<: *diskspd_max_throughput_flags
+
+kvrocks_memtier:
+  name: kvrocks_memtier
+  flags:
+    fio_fill_block_size: 64k
+    data_disk_type: local
+    num_striped_disks: 8
+    memtier_protocol: 'redis'
+    memtier_cluster_mode: True
+    memtier_clients: 1
+    memtier_threads: 4
+    memtier_pipeline: 1
+    memtier_data_size: 400
+    memtier_key_maximum: 18000000
+    memtier_key_prefix: 'key'
+    memtier_run_duration: 40
+    memtier_random_data: True
+    memtier_command: 'hmset __key__ field1 __data__ field2 __data__ field3 __data__ field4 __data__ field5 __data__ field6 __data__ field7 __data__ field8 __data__ field9 __data__ field10 __data__ field11 __data__ field12 __data__ field13 __data__ field14 __data__ field15 __data__ field16 __data__ field17 __data__ field18 __data__ field19 __data__'

perfkitbenchmarker/data/kvrocks/kvrocks.conf.jinja2

@@ -0,0 +1,48 @@
+daemonize yes
+timeout 0
+slowlog-max-len 128
+cluster-enabled yes
+rocksdb.max_write_buffer_number 16
+rocksdb.write_buffer_size 64
+rocksdb.max_background_jobs 4
+rocksdb.max_bytes_for_level_base 2147483647
+rocksdb.compression no
+workers 16
+max-replication-mb 500
+migrate-batch-rate-limit-mb 64
+cluster-enabled yes
+persist-cluster-nodes-enabled yes
+bind 0.0.0.0
+maxclients 60000
+rocksdb.block_size 4096
+migrate-speed 0
+migrate-pipeline-size 64
+migrate-batch-size-kb 64
+tcp-backlog 4096
+log-level warning
+slowlog-log-slower-than 20000
+rocksdb.level0_file_num_compaction_trigger 8
+# rocksdb.min_write_buffer_number_to_merge 4
+# rocksdb.max_sub_compactions 1
+rocksdb.compaction_readahead_size 1048576     #128k, max_sector_kb
+rocksdb.level0_slowdown_writes_trigger 30
+rocksdb.level0_stop_writes_trigger 60
+rocksdb.level0_file_num_compaction_trigger 8
+rocksdb.stats_dump_period_sec 60
+rocksdb.stats_dump_period_sec 60
+rocksdb.enable_pipelined_write yes
+# rocksdb.use_direct_reads no
+migrate-type raw-key-value
+rocksdb.wal_ttl_seconds 3600
+rocksdb.wal_size_limit_mb 32768
+requirepass {{password}}
+masterauth {{password}}
+max-db-size 256
+rocksdb.block_cache_size 16000
+log-retention-days 7
+
+
+port {{port}}
+dir /data/kv-{{instance_num}}
+log-dir /data/kv-{{instance_num}}/log
+backup-dir /data/kv-{{instance_num}}/backup

perfkitbenchmarker/data/kvrocks/prometheus.yaml.jinja2

@@ -0,0 +1,23 @@
+# prometheus.yml
+global:
+  scrape_interval: 5s
+  query_log_file: /prometheus/query.log
+scrape_configs:
+  - job_name: 'kvrocks_exporter_targets'
+    static_configs:
+      - targets:
+        {% for kvrocks_instance in kvrocks_instances %}
+        - kvrocks://{{kvrocks_instance.ip_address}}:{{kvrocks_instance.port}}
+        {% endfor %}
+    metrics_path: /scrape
+    relabel_configs:
+      - source_labels: [__address__]
+        target_label: __param_target
+      - source_labels: [__param_target]
+        target_label: instance
+      - target_label: __address__
+        replacement: {{kvrocks_exporter.ip_address}}:9180
+  - job_name: 'kvrocks_exporter'
+    static_configs:
+      - targets:
+        - {{kvrocks_exporter.ip_address}}:9180

perfkitbenchmarker/linux_benchmarks/kvrocks_memtier_benchmark.py

@@ -0,0 +1,199 @@
+# Copyright 2025 PerfKitBenchmarker Authors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Run memtier_benchmark against a KVrocks cluster."""
+
+import logging
+from typing import Any, Dict, List
+
+from absl import flags
+from perfkitbenchmarker import background_tasks
+from perfkitbenchmarker import benchmark_spec
+from perfkitbenchmarker import configs
+from perfkitbenchmarker import errors
+from perfkitbenchmarker import sample
+from perfkitbenchmarker.linux_packages import kvrocks_server
+from perfkitbenchmarker.linux_packages import memtier
+from perfkitbenchmarker.linux_packages import prometheus
+
+FLAGS = flags.FLAGS
+
+BENCHMARK_NAME = 'kvrocks_memtier'
+BENCHMARK_CONFIG = """
+kvrocks_memtier:
+  description: >
+      Run memtier_benchmark against KVrocks.
+  vm_groups:
+    servers:
+      vm_spec:
+        GCP:
+          machine_type: c3-standard-44-lssd
+      vm_count: 3
+      os_type: rocky-9
+      disk_spec:
+        GCP:
+          disk_type: local
+          num_striped_disks: 8
+          mount_point: /scratch
+        AWS:
+          disk_type: local
+          num_striped_disks: 8
+          mount_point: /scratch
+        Azure:
+          disk_type: local
+          num_striped_disks: 8
+          mount_point: /scratch
+    clients:
+      vm_spec:
+        GCP:
+          machine_type: n2-standard-64
+      vm_count: 1
+      os_type: rocky-9
+      disk_spec:
+        GCP:
+          disk_type: local
+          num_striped_disks: 8
+          mount_point: /scratch
+        AWS:
+          disk_type: local
+          num_striped_disks: 8
+          mount_point: /scratch
+        Azure:
+          disk_type: local
+          num_striped_disks: 8
+          mount_point: /scratch
+"""
+
+
+_BenchmarkSpec = benchmark_spec.BenchmarkSpec
+
+
+def GetConfig(user_config: Dict[str, Any]) -> Dict[str, Any]:
+  """Load and return benchmark config spec."""
+  return configs.LoadConfig(BENCHMARK_CONFIG, user_config, BENCHMARK_NAME)
+
+
+def CheckPrerequisites(_):
+  """Verifies that benchmark setup is correct."""
+  pass
+
+
+def Prepare(bm_spec: _BenchmarkSpec) -> None:
+  """Install and set up KVrocks and client tools."""
+  server_vms = bm_spec.vm_groups['servers']
+  client_vms = bm_spec.vm_groups['clients']
+  vms = server_vms + client_vms
+
+  background_tasks.RunThreaded(lambda vm: vm.Install('kvrocks_server'), vms)
+  background_tasks.RunThreaded(lambda vm: vm.Install('memtier'), client_vms)
+
+  def _InstallAndStartPrometheus(vm):
+    vm.Install('prometheus')
+    prometheus.ConfigureAndStart(vm, server_vms)
+
+  background_tasks.RunThreaded(_InstallAndStartPrometheus, client_vms)
+
+  # Skipping preconditioning for now.
+  # TODO(user): Add preconditioning.
+  kvrocks_server.StartCluster(server_vms)
+
+  def _StartExporter(vm):
+    kvrocks_server.StartExporter(vm)
+
+  # The prometheus server on the client is configured to scrape exporters
+  # from the server VMs.
+  background_tasks.RunThreaded(_StartExporter, server_vms)
+
+  prometheus.WaitUntilHealthy(client_vms[0])
+
+  # Check cluster status
+  master_vm = server_vms[0]
+
+  try:
+    cluster_info, _ = kvrocks_server.RunRedisCommand(
+        master_vm, '-c cluster info'
+    )
+    logging.info('KVrocks cluster info: %s', cluster_info)
+    cluster_nodes, _ = kvrocks_server.RunRedisCommand(
+        master_vm, '-c cluster nodes'
+    )
+    logging.info('KVrocks cluster nodes: %s', cluster_nodes)
+  except errors.VirtualMachine.RemoteCommandError as e:
+    logging.warning('KVrocks cluster not ready or redis commands failed: %s', e)
+
+
+def Run(bm_spec: _BenchmarkSpec) -> List[sample.Sample]:
+  """Run the memtier benchmark and collect results."""
+  client_vms = bm_spec.vm_groups['clients']
+  server_vms = bm_spec.vm_groups['servers']
+  master_vm = server_vms[0]
+  ip = master_vm.internal_ip
+  ports = list(kvrocks_server.INSTANCE_TO_PORT_MAP.values())
+
+  logging.info('Starting memtier runs...')
+  try:
+    results = memtier.RunOverAllThreadsPipelinesAndClients(
+        client_vms, ip, [ports[0]], kvrocks_server.GetPassword()
+    )
+  except errors.VirtualMachine.RemoteCommandError as e:
+    logging.exception('Memtier run failed: %s', e)
+    results = []
+  logging.info('Memtier runs finished. Results: %s', results)
+
+  metadata = kvrocks_server.GetMetadata()
+  for res in results:
+    res.metadata.update(metadata)
+
+  # Query prometheus stats from the first client
+  client_vm = client_vms[0]
+
+  slowlog_total = prometheus.RunQuery(client_vm, 'sum(kvrocks_slowlog_total)')
+  commands_total = prometheus.RunQuery(
+      client_vm, 'sum(kvrocks_commands_total{cmd="hmset"})'
+  )
+  slowlog_ratio = prometheus.RunQuery(
+      client_vm,
+      'sum(kvrocks_slowlog_total) / sum(kvrocks_commands_total{cmd="hmset"})',
+  )
+
+  logging.info('Slowlog total: %s', slowlog_total)
+  logging.info('Commands total: %s', commands_total)
+  logging.info('Slowlog ratio: %s', slowlog_ratio)
+
+  if slowlog_total is not None:
+    results.append(
+        sample.Sample('KVRocks Slowlog Total', slowlog_total, 'count', metadata)
+    )
+
+  if commands_total is not None:
+    results.append(
+        sample.Sample(
+            'KVRocks Commands Total HMSET',
+            commands_total,
+            'count',
+            metadata,
+        )
+    )
+
+  if slowlog_ratio is not None:
+    results.append(
+        sample.Sample('KVRocks Slowlog Ratio', slowlog_ratio, 'ratio', metadata)
+    )
+
+  return results
+
+
+def Cleanup(bm_spec: _BenchmarkSpec) -> None:
+  """Cleanup resources."""
+  del bm_spec