Public | Automated Build

Last pushed: 2 years ago
Short Description
Kafka load test tool -
Full Description


"...basically a cloth bag filled with small jagged pieces of scrap iron"


NOTE: Sangrenel locally bundles the latest release (v1.8.0) of Sarama (the Go client library), which builds properly with Sangrenel - but the functionally with this version has not been extensively tested.

Assuming Go is installed (tested with 1.6) and $GOPATH is set:

  • go get
  • go install

Binary will be found at $GOPATH/bin/sangrenel


Smashes Kafka queues with lots of messages and reports performance metrics (to console and optionally, Graphite). Usage overview:

% ./sangrenel -h
Usage of ./sangrenel:
-batch=0: Max messages per batch. Defaults to unlimited (0).
-brokers="localhost:9092": Comma delimited list of Kafka brokers
-clients=1: Number of Kafka client workers
-compression="none": Message compression: none, gzip, snappy
-graphite-ip="": Destination Graphite IP address
-graphite-metrics-prefix="random": Top-level Graphite namespace prefix (defaults to hostname)
-graphite-port="": Destination Graphite plaintext port
-noop=false: Test message generation performance, do not transmit messages
-producers=5: Number of producer instances per client
-rate=100000000: Apply a global message rate limit
-size=300: Message size in bytes
-topic="sangrenel": Topic to publish to

The <code>-clients</code> directive initializes n Kafka clients. Each client manages 5 Kafka producer instances (overridden with <code>-producers</code>) in goroutines that synchronously publish random messages of <code>-size</code> bytes to the referenced Kafka cluster/topic, as fast as possible. Kafka client worker counts need to be scaled up in order to produce more throughput, as each client connection maxes out throughput with roughly 5 producers instances. Configuring these variables allows you to roughly model arbitary topologies of connection counts and workers per connection. The <code>-rate</code> directive allows you to place a global cap on the total message rate for all workers combined.

Note: Sangrenel will automatically raise <code>GOMAXPROCS</code> to the value detected by <code>runtime.NumCPU()</code> to support increasing numbers of <code>-clients</code>. Sangrenel should be tested with <code>--noop</code> (messages are only generated but not transmitted to the brokers) in order to determine the maximum message rate that the configured message size and worker setting can generate. Otherwise, you may see a throughput rate that's computationally bound versus the actual limitation of the Kafka brokers being testing.

If a topic is referenced that does not yet exist, Sangrenel will create one with a default of 2 partitions / 1 replica (or as defined in your Kafka server configuration). Alternative parition/replica topologies should be created manually prior to running Sangrenel.

Sangrenel outputs metrics based on the previous 5 seconds of operation: the aggregate amount of data being produced, message transaction rate (or generated rate if using <code>--noop</code>) and 90th percentile worst latency average (time from message sent to receiving an ack from the broker).

If optionally defined, Graphite can be used as a secondary output location. This allows you to graph performance results in addition to overlaying Sangrenel metrics against Kafka cluster metrics that you may already be collecting in Graphite.

% ./sangrenel -brokers="" -size=250 -topic=load -clients=4 -graphite-ip="" -graphite-port="2013"

::: Sangrenel :::

Starting 4 client workers, 5 producers per worker
Message size 250 bytes, 0 message limit per batch
Compression: none

2015/03/20 11:19:14 client_1 connected
2015/03/20 11:19:14 client_2 connected
2015/03/20 11:19:14 client_4 connected
2015/03/20 11:19:15 client_3 connected
2015/03/20 11:19:19 Generating 27Mb/sec @ 14387 messages/sec | topic: load | 2.30ms 90%ile latency
2015/03/20 11:19:19 Metrics flushed to Graphite
2015/03/20 11:19:24 Generating 28Mb/sec @ 14582 messages/sec | topic: load | 2.21ms 90%ile latency
2015/03/20 11:19:24 Metrics flushed to Graphite
2015/03/20 11:19:29 Generating 28Mb/sec @ 14772 messages/sec | topic: load | 2.22ms 90%ile latency
2015/03/20 11:19:29 Metrics flushed to Graphite
2015/03/20 11:19:34 Generating 29Mb/sec @ 15110 messages/sec | topic: load | 2.16ms 90%ile latency
2015/03/20 11:19:34 Metrics flushed to Graphite
2015/03/20 11:19:39 Generating 29Mb/sec @ 15057 messages/sec | topic: load | 2.16ms 90%ile latency
2015/03/20 11:19:39 Metrics flushed to Graphite

Messages/sec. vs latency:

MB/s. vs latency (Sangrenel writes byte values, so this can be viewed as Mb and Gb in Grafana):


Sangrenel obliterating all cores on an EC2 c4.8xlarge instance in <code>noop</code> mode, generating over 6.4Gb/s of random message data:

Docker Pull Command
Source Repository