perfkitbenchmarker/linux_benchmarks/memcached_mutilate_benchmark.py

# Copyright 2020 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.

"""Runs multilate benchmark against memcached on cloud virtual machines.

Memcached is an in-memory key-value store for small chunks of arbitrary
data (strings, objects) from results of database calls, API calls, or page
rendering.
Memcached homepage: https://memcached.org/

Mutilate: https://github.com/leverich/mutilate
Basic Usage:
https://github.com/leverich/mutilate#basic-usage

Mutilate is a load generator for benchmarking memcached.
Compared to memtier_memcached benchmark, this benchmark
added following additional features provided by mutilate:
- Support of multiple client vms (remote agents).
- Measure_* options, allowing taking latency measurements of the
memcached server without incurring significant client-side queuing
delay.
- Setting keysize.
"""


import functools
import time

from absl import flags
from perfkitbenchmarker import background_tasks
from perfkitbenchmarker import configs
from perfkitbenchmarker.linux_packages import memcached_server
from perfkitbenchmarker.linux_packages import mutilate

FLAGS = flags.FLAGS


_SERVER_VM_TYPE = flags.DEFINE_string(
    'memcached_mutilate_server_machine_type',
    None,
    'Machine type to use for the memcached server if different '
    'from memcached client machine type.',
)
_CLIENT_VM_TYPE = flags.DEFINE_string(
    'memcached_mutilate_client_machine_type',
    None,
    'Machine type to use for the mutilate client if different '
    'from memcached server machine type.',
)
_CLIENT_COUNT = flags.DEFINE_integer(
    'memcached_mutilate_num_client_vms',
    1,
    'Number of mutilate client machines to use. '
    'To run memcached/mutilate on same machine, set to 0.',
)
_SMP = flags.DEFINE_boolean(
    'set_smp_affinity', False, 'Manually set smp affinity.'
)
_NUM_INSTANCES = flags.DEFINE_integer(
    'memcached_num_local_instances',
    1,
    'Number of memcached instancs to launch locally.',
)

BENCHMARK_NAME = 'memcached_mutilate'
BENCHMARK_CONFIG = """
memcached_mutilate:
  description: Run mutilate against a memcached installation.
  vm_groups:
    server:
      vm_spec: *default_dual_core
      vm_count: 1
    client:
      vm_spec: *default_dual_core
      vm_count: 1
"""


def CheckPrerequisites(benchmark_config):
  """Verifies that the required resources are present.

  Args:
    benchmark_config: The benchmark configuration.

  Raises:
    perfkitbenchmarker.data.ResourceNotFound: On missing resource.
  """
  del benchmark_config
  mutilate.CheckPrerequisites()


def GetConfig(user_config):
  """Load and return benchmark config.

  Args:
    user_config: user supplied configuration (flags and config file)

  Returns:
    loaded benchmark configuration
  """
  config = configs.LoadConfig(BENCHMARK_CONFIG, user_config, BENCHMARK_NAME)
  if _CLIENT_VM_TYPE.value:
    vm_spec = config['vm_groups']['client']['vm_spec']
    for cloud in vm_spec:
      vm_spec[cloud]['machine_type'] = _CLIENT_VM_TYPE.value
  if _SERVER_VM_TYPE.value:
    vm_spec = config['vm_groups']['server']['vm_spec']
    for cloud in vm_spec:
      vm_spec[cloud]['machine_type'] = _SERVER_VM_TYPE.value
  if FLAGS['memcached_mutilate_num_client_vms'].present:
    config['vm_groups']['client']['vm_count'] = _CLIENT_COUNT.value
  return config


def _InstallMutilate(vm):
  vm.Install('mutilate')


def _InstallMemcached(vm):
  vm.Install('memcached_server')


def GetClients(benchmark_spec):
  """Get client VMs."""
  if _CLIENT_COUNT.value:
    return benchmark_spec.vm_groups['client']
  return benchmark_spec.vm_groups['server']


def GetServerIp(server):
  """Get server ip."""
  return server.internal_ip if _CLIENT_COUNT.value else 'localhost'


def Prepare(benchmark_spec):
  """Prepare the virtual machines to run mutilate against memcached.

  Args:
    benchmark_spec: The benchmark specification. Contains all data that is
      required to run the benchmark.
  """
  clients = GetClients(benchmark_spec)
  server = benchmark_spec.vm_groups['server'][0]
  client_install_fns = [
      functools.partial(vm.Install, 'mutilate') for vm in clients
  ]
  server_install_fns = [functools.partial(server.Install, 'memcached_server')]
  background_tasks.RunThreaded(
      lambda f: f(), client_install_fns + server_install_fns
  )


def Run(benchmark_spec):
  """Runs mutilate against memcached and gathers the results.

  Args:
    benchmark_spec: The benchmark specification. Contains all data that is
      required to run the benchmark.

  Returns:
    A list of sample.Sample instances.
  """
  clients = GetClients(benchmark_spec)
  server = benchmark_spec.vm_groups['server'][0]
  server_ip = GetServerIp(server)
  memcached_server.StopMemcached(server)
  time.sleep(60)
  for idx in range(_NUM_INSTANCES.value):
    port = memcached_server.MEMCACHED_PORT + idx
    memcached_server.ConfigureAndStart(
        server, port=port, smp_affinity=_SMP.value
    )
    mutilate.Load(clients[0], server_ip, port)

  metadata = {
      'memcached_version': memcached_server.GetVersion(server),
      'memcached_server_size': FLAGS.memcached_size_mb,
      'memcached_server_threads': FLAGS.memcached_num_threads,
      'memcached_local_instances': _NUM_INSTANCES.value,
      'smp_affinity': _SMP.value,
  }

  samples = mutilate.Run(
      clients, server_ip, memcached_server.MEMCACHED_PORT, _NUM_INSTANCES.value
  )
  for sample in samples:
    sample.metadata.update(metadata)

  return samples


def Cleanup(unused_benchmark_spec):
  pass