• Stars
    star
    1,139
  • Rank 38,539 (Top 0.8 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created almost 14 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Twitter's collection of LZO and Protocol Buffer-related Hadoop, Pig, Hive, and HBase code.

Elephant Bird Build Status

About

Elephant Bird is Twitter's open source library of LZO, Thrift, and/or Protocol Buffer-related Hadoop InputFormats, OutputFormats, Writables, Pig LoadFuncs, Hive SerDe, HBase miscellanea, etc. The majority of these are in production at Twitter running over data every day.

Join the conversation about Elephant-Bird on the developer mailing list.

License

Apache License, Version 2.0.

Quickstart

  1. Make sure you have Protocol Buffers installed. Please see Version compatibility section below.
  2. Make sure you have Apache Thrift installed. Please see Version compatibility section below.
  3. Get the code: git clone git://github.com/twitter/elephant-bird.git
  4. Build the jar: mvn package
  5. Explore what's available: mvn javadoc:javadoc

Note: For any of the LZO-based code, make sure that the native LZO libraries are on your java.library.path. Generally this is done by setting JAVA_LIBRARY_PATH in pig-env.sh or hadoop-env.sh. You can also add lines like

PIG_OPTS=-Djava.library.path=/path/to/my/libgplcompression/dir

to pig-env.sh. See the instructions for Hadoop-LZO for more details.

There are a few simple examples that use the input formats. Note how the Protocol Buffer and Thrift classes are passed to input formats through configuration.

Maven repository

Elephant Bird release artifacts are published to the Sonatype OSS releases repository and promoted from there to Maven Central. From time to time we may also deploy snapshot releases to the Sonatype OSS snapshots repository.

Version compatibility

  1. Hadoop 20.2x, 1.x, 2.x
  2. Pig 0.8+
  3. Protocol Buffers 2.5.0, 2.4.1, 2.3.0 (default build version is 2.4.1 can be changed with -Dprotobuf.version=2.3.0)
  4. Hive 0.7 (with HIVE-1616)
  5. Thrift 0.5.0, 0.6.0, 0.7.0, greater versions than 0.9 are provided via thrift9 maven profile
  6. Mahout 0.6
  7. Cascading2 (as the API is evolving, see libraries.properties for the currently supported version)
  8. Crunch 0.8.1+

Runtime Dependencies

Elephant-Bird defines majority of its depenendencies in maven provided scope. As a result these dependencies are not transitively Elephant-Bird modules. Please see wiki page for more information.

Contents

Hadoop Input and Output Formats

Elephant-Bird provides input and output formats for working with a variety of plaintext formats stored in LZO compressed files.

  • JSON data
  • Line-based data (TextInputFormat but for LZO)
  • W3C logs

Additionally, protocol buffers and thrift messages can be stored in a variety of file formats.

  • Block-based, into generic bytes
  • Line-based, base64 encoded
  • SequenceFile
  • RCFile

Hadoop API wrappers

Hadoop provides two API implementations: the the old-style org.apache.hadoop.mapred and new-style org.apache.hadoop.mapreduce packages. Elephant-Bird provides wrapper classes that allow unmodified usage of mapreduce input and output formats in contexts where the mapred interface is required.

For more information, see DeprecatedInputFormatWrapper.java and DeprecatedOutputFormatWrapper.java

Hadoop 2.x Support

Elephant-bird published packages are tested with both Hadoop 1.x and 2.x.

Hadoop Writables

  • Elephant-Bird provides protocol buffer and thrift writables for directly working with these formats in map-reduce jobs.

Pig Support

Loaders and storers are available for the input and output formats listed above. Additionally, pig-specific features include:

  • JSON loader (including nested structures)
  • Regex-based loader
  • Includes converter interface for turning Tuples into Writables and vice versa
  • Provides implementations to convert generic Writables, Thrift, Protobufs, and other specialized classes, such as Apache Mahout's VectorWritable.

Hive Support

Elephant-Bird provides Hive support for reading thrift and protocol buffers. For more information, see How to use Elephant Bird with Hive.

Lucene Integration

Elephant-Bird provides hadoop Input/Output Formats and pig Load/Store Funcs for creating + searching lucene indexes. See Elephant Bird Lucene

Utilities

  • Counters in Pig
  • Protocol Buffer utilities
  • Thrift utilities
  • Conversions from Protocol Buffers and Thrift messages to Pig tuples
  • Conversions from Thrift to Protocol Buffer's DynamicMessage
  • Reading and writing block-based Protocol Buffer format (see ProtobufBlockWriter)

Protocol Buffer and Thrift compiler dependencies

Elephant Bird requires Protocol Buffer compiler at build time, as generated classes are used internally. Thrift compiler is required to generate classes used in tests. As these are native-code tools they must be installed on the build machine (java library dependencies are pulled from maven repositories during the build).

Working with Thrift and Protocol Buffers in Hadoop

We provide InputFormats, OutputFormats, Pig Load / Store functions, Hive SerDes, and Writables for working with Thrift and Google Protocol Buffers. We haven't written up the docs yet, but look at ProtobufMRExample.java, ThriftMRExample.java, people_phone_number_count.pig, people_phone_number_count_thrift.pig under examples directory for reflection-based dynamic usage. We also provide utilities for generating Protobuf-specific Loaders, Input/Output Formats, etc, if for some reason you want to avoid the dynamic bits.

Hadoop SequenceFiles and Pig

Reading and writing Hadoop SequenceFiles with Pig is supported via classes SequenceFileLoader and SequenceFileStorage. These classes make use of a WritableConverter interface, allowing pluggable conversion of key and value instances to and from Pig data types.

Here's a short example: Suppose you have SequenceFile<Text, LongWritable> data sitting beneath path input. We can load that data with the following Pig script:

REGISTER '/path/to/elephant-bird.jar';

%declare SEQFILE_LOADER 'com.twitter.elephantbird.pig.load.SequenceFileLoader';
%declare TEXT_CONVERTER 'com.twitter.elephantbird.pig.util.TextConverter';
%declare LONG_CONVERTER 'com.twitter.elephantbird.pig.util.LongWritableConverter';

pairs = LOAD 'input' USING $SEQFILE_LOADER (
  '-c $TEXT_CONVERTER', '-c $LONG_CONVERTER'
) AS (key: chararray, value: long);

To store {key: chararray, value: long} data as SequenceFile<Text, LongWritable>, the following may be used:

%declare SEQFILE_STORAGE 'com.twitter.elephantbird.pig.store.SequenceFileStorage';

STORE pairs INTO 'output' USING $SEQFILE_STORAGE (
  '-c $TEXT_CONVERTER', '-c $LONG_CONVERTER'
);

For details, please see Javadocs in the following classes:

How To Contribute

Bug fixes, features, and documentation improvements are welcome! Please fork the project and send us a pull request on github.

Each new release since 2.1.3 has a tag. The latest version on master is what we are actively running on Twitter's hadoop clusters daily, over hundreds of terabytes of data.

Contributors

Major contributors are listed below. Lots of others have helped too, thanks to all of them! See git logs for credits.

More Repositories

1

the-algorithm

Source code for Twitter's Recommendation Algorithm
Scala
60,419
star
2

typeahead.js

typeahead.js is a fast and fully-featured autocomplete library
JavaScript
16,540
star
3

twemoji

Emoji for everyone. https://twemoji.twitter.com/
HTML
16,448
star
4

twemproxy

A fast, light-weight proxy for memcached and redis
C
11,940
star
5

the-algorithm-ml

Source code for Twitter's Recommendation Algorithm
Python
9,788
star
6

finagle

A fault tolerant, protocol-agnostic RPC system
Scala
8,716
star
7

hogan.js

A compiler for the Mustache templating language
JavaScript
5,139
star
8

labella.js

Placing labels on a timeline without overlap.
JavaScript
3,864
star
9

scala_school

Lessons in the Fundamentals of Scala
HTML
3,698
star
10

AnomalyDetection

Anomaly Detection with R
R
3,525
star
11

scalding

A Scala API for Cascading
Scala
3,465
star
12

twitter-text

Twitter Text Libraries. This code is used at Twitter to tokenize and parse text to meet the expectations for what can be used on the platform.
HTML
3,041
star
13

TwitterTextEditor

A standalone, flexible API that provides a full-featured rich text editor for iOS applications.
Swift
2,938
star
14

opensource-website

Twitter's open source website, identifying projects we've released, organizations we support, and the work we do to support open source.
SCSS
2,852
star
15

util

Wonderful reusable code from Twitter
Scala
2,671
star
16

algebird

Abstract Algebra for Scala
Scala
2,275
star
17

finatra

Fast, testable, Scala services built on TwitterServer and Finagle
Scala
2,269
star
18

effectivescala

Twitter's Effective Scala Guide
HTML
2,237
star
19

summingbird

Streaming MapReduce with Scalding and Storm
Scala
2,137
star
20

pelikan

Pelikan is Twitter's unified cache backend
C
1,914
star
21

ios-twitter-image-pipeline

Twitter Image Pipeline is a robust and performant image loading and caching framework for iOS clients
C
1,850
star
22

twurl

OAuth-enabled curl for the Twitter API
Ruby
1,782
star
23

rezolus

Systems performance telemetry
Rust
1,539
star
24

twitter-server

Twitter-Server defines a template from which services at Twitter are built
Scala
1,522
star
25

activerecord-reputation-system

An Active Record Reputation System for Rails
Ruby
1,335
star
26

fatcache

Memcache on SSD
C
1,306
star
27

compose-rules

Static checks to aid with a healthy adoption of Compose
Kotlin
1,293
star
28

rsc

Experimental Scala compiler focused on compilation speed
Scala
1,243
star
29

communitynotes

Documentation and source code powering Twitter's Community Notes
Python
1,146
star
30

cassovary

Cassovary is a simple big graph processing library for the JVM
Scala
1,039
star
31

Serial

Light-weight, fast framework for object serialization in Java, with Android support.
Java
982
star
32

hbc

A Java HTTP client for consuming Twitter's realtime Streaming API
Java
962
star
33

twemcache

Twemcache is the Twitter Memcached
C
926
star
34

innovators-patent-agreement

Innovators Patent Agreement (IPA)
917
star
35

vireo

Vireo is a lightweight and versatile video processing library written in C++11
C++
915
star
36

twitter-korean-text

Korean tokenizer
Scala
831
star
37

scrooge

A Thrift parser/generator
Scala
785
star
38

BreakoutDetection

Breakout Detection via Robust E-Statistics
C++
751
star
39

GraphJet

GraphJet is a real-time graph processing library.
Java
694
star
40

twitter-cldr-rb

Ruby implementation of the ICU (International Components for Unicode) that uses the Common Locale Data Repository to format dates, plurals, and more.
Ruby
663
star
41

bijection

Reversible conversions between types
Scala
662
star
42

chill

Scala extensions for the Kryo serialization library
Scala
603
star
43

ios-twitter-network-layer

Twitter Network Layer is a scalable and feature rich network layer built on top of NSURLSession for Apple platforms
Objective-C
572
star
44

hadoop-lzo

Refactored version of code.google.com/hadoop-gpl-compression for hadoop 0.20
Shell
544
star
45

storehaus

Storehaus is a library that makes it easy to work with asynchronous key value stores
Scala
465
star
46

rpc-perf

A tool for benchmarking RPC services
Rust
459
star
47

d3kit

D3Kit is a set tools to speed D3 related project development
JavaScript
427
star
48

scoot

Scoot is a distributed task runner, supporting both a proprietary API and Bazel's Remote Execution.
Go
347
star
49

twitter-cldr-js

JavaScript implementation of the ICU (International Components for Unicode) that uses the Common Locale Data Repository to format dates, plurals, and more. Based on twitter-cldr-rb.
JavaScript
344
star
50

scala_school2

Scala School 2
Scala
342
star
51

rustcommon

Common Twitter Rust lib
Rust
340
star
52

wordpress

The official Twitter plugin for WordPress. Embed Twitter content and grow your audience on Twitter.
PHP
311
star
53

ios-twitter-logging-service

Twitter Logging Service is a robust and performant logging framework for iOS clients
Objective-C
300
star
54

nodes

A library to implement asynchronous dependency graphs for services in Java
Java
246
star
55

SentenTree

A novel text visualization technique
JavaScript
223
star
56

interactive

Twitter interactive visualization
HTML
213
star
57

joauth

A Java library for authenticating HTTP Requests using OAuth
Java
210
star
58

thrift_client

A Thrift client wrapper that encapsulates some common failover behavior
Ruby
196
star
59

hpack

Header Compression for HTTP/2
Java
194
star
60

zktraffic

ZooKeeper protocol analyzer and stats gathering daemon
Python
164
star
61

twemoji-parser

A simple library for identifying emoji entities within a string in order to render them as Twemoji.
Scala
157
star
62

sbf

Java
154
star
63

cache-trace

A collection of Twitter's anonymized production cache traces.
Shell
151
star
64

tormenta

Scala extensions for Storm
Scala
132
star
65

whiskey

HTTP library for Android (beta)
Java
132
star
66

hraven

hRaven collects run time data and statistics from MapReduce jobs in an easily queryable format
Java
129
star
67

netty-http2

HTTP/2 for Netty
Java
121
star
68

ccommon

Cache Commons
C
99
star
69

sqrl

A Safe, Stateful Rules Language for Event Streams
TypeScript
99
star
70

focus

Focus aligns Git worktree content based on outlines of a repository's Bazel build graph. Focused repos are sparse, shallow, and thin and unlock markedly better performance in large repos.
Rust
89
star
71

dict_minimize

Access scipy optimizers from your favorite deep learning framework.
Python
74
star
72

metrics

74
star
73

twitter.github.io

HTML
71
star
74

go-bindata

Go
67
star
75

diffusion-rl

Python
65
star
76

birdwatch

64
star
77

cloudhopper-commons

Cloudhopper Commons
Java
57
star
78

twitter-cldr-npm

TwitterCldr npm package
JavaScript
49
star
79

.github

Twitter GitHub Organization-wide files
46
star
80

bazel-multiversion

Bazel rules to resolve, fetch and manage 3rdparty JVM dependencies with support for multiple parallel versions of the same dependency. Powered by Coursier.
Scala
45
star
81

libwatchman

A C interface to watchman
C
44
star
82

sslconfig

Twitter's OpenSSL Configuration
42
star
83

gatekeeper-service

GateKeeper is a service built to automate the manual steps involved in onboarding, offboarding, and lost asset scenarios.
Python
36
star
84

ios-twitter-apache-thrift

A thrift encoding and decoding library for Swift
Swift
36
star
85

dodo

The Twitter OSS Project Builder
Shell
35
star
86

repo-scaffolding

Tools for creating repos based on open source standards and best practices
31
star
87

iago2

A load generator, built for engineers
Scala
24
star
88

caladrius

Performance modelling system for Distributed Stream Processing Systems (DSPS) such as Apache Heron and Apache Storm
Python
22
star
89

ossdecks

Repository for Twitter Open Source Decks
10
star
90

curation-style-guide

Document Repository for Twitter's Curation Style Guide
10
star
91

analytics-infra-governance

Description of the process for how to commit, review, and release code to the Scalding OSS family (Scalding, Summingbird, Algebird, Bijection, Storehaus, etc)
9
star
92

gpl-commitment

Twitter's GPL Cooperation Commitment
5
star
93

second-control-probability-distributions

4
star
94

google-tag-manager-event-tag

Smarty
3
star
95

google-tag-manager-base-tag

Smarty
2
star