Charmed Kafka Benchmark

Learn about configurations >

• duration | int

  Time in seconds to run the benchmark, 0 means indefinitely.

• override_access_hostname | string

  Overrides the default relation endpoint shared via client relation, e.g. if we have a VIP in front of the databases and we want to test it through VIP instead of the relation's default value.

• parallel_processes | int

  Default: 1

  Number of parallel process managed by the benchmark tool. Minimum is 2.

• report_interval | int

  Default: 1

  Int, number of seconds we should periodically report interval

• run_count | int

  Number of counts to run, 0 means indefinitely. If both duration and run_count are set, duration takes precedence.

• test_name | string

  Default: kafka-benchmark

  Used to identify the test. MUST NOT be empty. It is the string that represents the given test (e.g. "aws_c6a.xlarge_3nodes_<WORKLOAD>"). It is used by the collector to put the final data on the right place.

• threads | int

  Default: 1

  Number of concurrent tasks within a given process. The best way to understand this concept is to imagine it as python coroutines running concurrently within the same process.

• workload_name | string

  Default: default

  The name of the workload to be prepared and used.