Hadoop utilities for Kafka, S3, and more
Latest commit 3b1155d Sep 4, 2015 @ctiwald ctiwald Merge pull request #6 from ty707/snappy-framing
Adding Snappy Framing Compression Codec for Hadoop



Kangaroo is Conductor's collection of open source Hadoop Map/Reduce utilities.

Currently, Kangaroo includes:

  1. A scalable Kafka input format
  2. Several FileInputFormats optimized for S3 input data.
  3. A input format for distributed task execution
  4. A compression codec for the framing format of Snappy

Setting up Kangaroo

You can build Kangaroo with:

mvn clean package

Using the Kafka Input Format

For more details, check out our blog post about the Kafka input format.

For a Kafka 0.8.1-compatible version of this code, see this branch. (It compiles, is unit tested, but completely untested in the wild - please help us get it up to snuff!)

Create a Mapper

public static class MyMapper extends Mapper<LongWritable, BytesWritable, KEY_OUT, VALUE_OUT> {

    protected void map(final LongWritable key, final BytesWritable value, final Context context) throws IOException, InterruptedException {
        // implementation
  • The BytesWritable value is the raw bytes of a single Kafka message.
  • The LongWritable key is the Kafka offset of the message.

Single topic

// Create a new job
final Job job = Job.getInstance(getConf(), "my_job");

// Set the InputFormat

// Set your Zookeeper connection string
KafkaInputFormat.setZkConnect(job, "zookeeper-1.xyz.com:2181");

// Set the topic you want to consume
KafkaInputFormat.setTopic(job, "my_topic");

// Set the consumer group associated with this job
KafkaInputFormat.setConsumerGroup(job, "my_consumer_group");

// Set the mapper that will consume the data

// (Optional) Only commit offsets if the job is successful
if (job.waitForCompletion(true)) {
    final ZkUtils zk = new ZkUtils(job.getConfiguration());
    zk.commit("my_consumer_group", "my_topic");

Multiple topics

// Create a new job
final Job job = Job.getInstance(getConf(), "my_job");

// Set the InputFormat

// Set your Zookeeper connection string
KafkaInputFormat.setZkConnect(job, "zookeeper-1.xyz.com:2181");

// Add as many queue inputs as you'd like
MultipleKafkaInputFormat.addTopic(job, "my_first_topic", "my_consumer_group", MyMapper.class);
MultipleKafkaInputFormat.addTopic(job, "my_second_topic", "my_consumer_group", MyMapper.class);
// ...

// (Optional) Only commit offsets if the job is successful
if (job.waitForCompletion(true)) {
    final ZkUtils zk = new ZkUtils(job.getConfiguration());
    // commit the offsets for each topic
    zk.commit("my_consumer_group", "my_first_topic");
    zk.commit("my_consumer_group", "my_second_topic");
    // ...

Customize Your Job

Our Kafka input format allows you to limit the number of splits consumed in a single job:

  • By consuming data created approximately on or after a timestamp.
// Consume Kafka partition files with were last modified on or after October 13th, 2014
KafkaInputFormat.setIncludeOffsetsAfterTimestamp(job, 1413172800000);
  • By consuming a maximum number of Kafka partition files (splits), per Kafka partition.
// Consume the oldest five unconsumed Kafka files per partition
KafkaInputFormat.setMaxSplitsPerPartition(job, 5);

Static Access to InputSplits

Our Kafka input format exposes static access to a hypothetical job's KafkaInputSplits. We've found this information useful when estimating the number of reducers for certain jobs. This calculation is pretty fast; for a topic with 30 partitions on a 10-node Kafka cluster, this calculation took about 1 second.

final Configuration conf = new Configuration();
conf.set("kafka.zk.connect", "zookeeper-1.xyz.com:2181");

// Get all splits for "my_topic"
final List<InputSplit> allTopicSplits = KafkaInputFormat.getAllSplits(conf, "my_topic");
// Get all of "my_consumer_group"'s splits for "my_topic"
final List<InputSplit> consumerSplits = KafkaInputFormat.getSplits(conf, "my_topic", "my_consumer_group");

// Do some interesting calculations...
long totalInputBytesOfJob = 0;
for (final InputSplit split : consumerSplits) {
    totalInputBytesOfJob += split.getLength();

Using the S3 Input Formats

The job setup of these FileInputFormats are optimized for S3. Namely, each one:

  1. Uses the AmazonS3 client instead of the S3FileSystem.
  2. Uses AmazonS3.listObjects to efficiently discover input files recursively.
  3. Trims out all of the FileSystem operations that are irrelevant to S3.

Th overall performance boost varies based on the number of input directories (S3 prefixes in this case). With 10 or more input directories, you can expect 2-3x faster split discovery.

If your input directories share a common S3 prefix, only add the common prefix to your job. This will give you the biggest performance boost because the input format takes advantage of AmazonS3.listObjects. In one test of 7000 input files that shared a common prefix, our input format discovered splits in 10 seconds, whereas the Hadoop FileInputFormat took 730 seconds.

Job setup

You use these input formats exactly the way you normally use SequenceFileInputFormat or TextFileInputFormat, except you specify our S3 input format on the job settings:

// put your AWS credentials in the Configuration
final Configuration conf = new Configuration();
conf.set("fs.s3n.awsAccessKeyId", "YOUR_AWS_KEY");
conf.set("fs.s3n.awsSecretAccessKey", "YOUR_AWS_SECRET");

// create a job
final Job job = Job.getInstance(getConf(), "my_job");

// This is the only difference! All other settings are exactly the same.

// add your input paths - if your input paths share a common prefix, just add the parent prefix!!
SequenceFileInputFormat.addInputPath(job, new Path("s3n://my-bucket/input/path"));
SequenceFileInputFormat.addInputPath(job, new Path("s3n://my-bucket/other/path"));

// other FileInputFormat or SequenceFileInputFormat settings... other job settings...

Available Input Formats

S3 Input Format Corresponding Hadoop Input Format
S3SequenceFileInputFormat org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat
S3TextInputFormat org.apache.hadoop.mapreduce.lib.input.TextInputFormat
S3SequenceFileInputFormatMRV1 org.apache.hadoop.mapred.TextInputFormat
S3TextInputFormatMRV1 org.apache.hadoop.mapred.SequenceFileInputFormat

We've included MRV1 versions of these input formats, which we use for S3-backed Hive tables.

Distributed task execution using WritableValueInputFormat

When multiple threads in a single JVM won't suffice, Kangaroo comes to the Rescue. The WritableValueInputFormat allows you to distribute computational work across a configurable number of map tasks in Map/Reduce.

Create a Mapper

Your mapper will take a NullWritable key, and a value that must implement Writable.

public static class MyComputationalMapper extends Mapper<NullWritable, UnitOfWork, KEY_OUT, VALUE_OUT> {

    protected void map(final NullWritable key, final UnitOfWork value, final Context context) throws IOException, InterruptedException {
        // process UnitOfWork, and output the result(s) if you want to reduce it

Job setup

To setup a Job, calculate the units of work and specify exactly how many inputs each map task gets.

// compute the work to be done
final List<UnitOfWork> workToBeDone = ...;

// Create the job and setup your input, specifying 50 units of work per mapper.
final Job job = Job.getInstance(getConf(), "my_job");
WritableValueInputFormat.setupInput(workToBeDone, UnitOfWork.class, 50, job);

// If you want to add EVEN MORE concurrency to your job, use the MultithreadedMapper!
MultithreadedMapper.setMapperClass(job, MyComputationalMapper.class); // your actual mapper
MultithreadedMapper.setNumberOfThreads(job, 10); // 10 threads per mapper

Snappy Framing Compression Codec

com.conductor.hadoop.compress.SnappyFramedCodec will allow your Map/Reduce jobs to read and write files compressed in the Snappy framing format. Firstly, make sure that you set the following hadoop configuration properties accordingly (property names may vary by distribution, the below are for CDH4/YARN):

Property Name Meaning Optional? Value
io.compression.codecs Registry of available compression codecs no ...,com.conductor.hadoop.compress.SnappyFramedCodec,...
mapred.map.output.compression.codec Compression codec for intermediate (map) output yes, except for map-only jobs com.conductor.hadoop.compress.SnappyFramedCodec
mapred.output.compression.codec Compression codec for final (reduce) output no com.conductor.hadoop.compress.SnappyFramedCodec