Skip to content
This repository has been archived by the owner on Jul 7, 2020. It is now read-only.

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
cburroughs committed Dec 27, 2013
0 parents commit 4dc2708
Show file tree
Hide file tree
Showing 1,468 changed files with 472,871 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .gitignore
@@ -0,0 +1,17 @@
target/
test.http.get/
.classpath
.project
.settings/
.idea/
hydra-local/
hydra-data/indexes/
hydra-data/query.tmp
hydra*.iml
pom.xml.versionsBackup
.#*
docs/build/
hydra.ipr
hydra.iws
hydra-uber/src/main/resources/hydra-git.properties
*.pyc
177 changes: 177 additions & 0 deletions LICENSE
@@ -0,0 +1,177 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
64 changes: 64 additions & 0 deletions NOTICE
@@ -0,0 +1,64 @@
hydra
Copyright 2013 AddThis

This product includes software developed by AddThis.


This product also includes the following third-party components

jQuery (http://jquery.org/)
Copyright 2012 jQuery Foundation and other contributors

date.js (http://www.datejs.com/)
Copyright 2006-2007, Coolite Inc.

google-code-prettify (https://code.google.com/p/google-code-prettify/)
Copyright 2006 Google Inc.

prototypejs (http://www.prototypejs.org/)
Copyright 2005-2009 Sam Stephenson

codemirror (http://codemirror.net/)
Copyright (C) 2013 by Marijn Haverbeke <marijnh@gmail.com> and others

Bootstrap (http://getbootstrap.com/)
Copyright 2013 Twitter, Inc

DataTables (http://datatables.net/)
Copyright 2008-2012 Allan Jardine

Ace (http://ace.c9.io/)
Copyright (c) 2010, Ajax.org B.V.

alertify.js (http://fabien-d.github.com/alertify.js/)
copyright Fabien Doiron 2013

Backbone.js (http://backbonejs.org)
2010-2013 Jeremy Ashkenas, DocumentCloud Inc

d3 (http://d3js.org/)
Copyright (c) 2013, Michael Bostock

RequireJS domReady (http://github.com/requirejs/domReady)
Copyright 2010-2012 The Dojo Foundation

jasmine (http://pivotal.github.io/jasmine/)
Copyright (c) 2008-2011 Pivotal Labs

jQuery resize event (http://benalman.com/projects/jquery-resize-plugin/)
Copyright (c) 2010 "Cowboy" Ben Alman

jQuery Cookie Plugin (https://github.com/carhartl/jquery-cookie)
Copyright 2013 Klaus Hartl

RequireJS (http://github.com/jrburke/requirejs)
Copyright (c) 2010-2012, The Dojo Foundation

jsSHA (http://caligatio.github.com/jsSHA/)
Copyright Brian Turek 2008-2013

Underscore.js (http://underscorejs.org)
(c) 2009-2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors



128 changes: 128 additions & 0 deletions README.mdown
@@ -0,0 +1,128 @@
## hydra

Hydra is a distributed data processing and storage system originally
developed at [AddThis](http://www.addthis.com). It ingests streams of
data (think log files) and builds trees that are aggregates,
summaries, or transformations of the data. These trees can be used by
humans to explore (tiny queries), as part of a machine learning
pipeline (big queries), or to support live consoles on websites (lots
of queries).

You can run hydra from the command line to slice and dice that Apache
access log you have sitting around (or that gargantuan csv file). Or
if terabytes per day is your cup of tea run a Hydra Cluster that
supports your job with resource sharing, job management, distributed
backups, data partitioning, and efficient bulk file transfer.

## Building

Assuming you have [Apache Maven](http://maven.apache.org/) installed
and configured:

mvn package

Should compile and build jars. All hydra dependencies should be
available on maven central but hydra itself is not yet published.

[Berkeley DB Java Edition](http://www.oracle.com/technetwork/database/berkeleydb/overview/index-093405.html)
is used for several core features. The sleepycat license has strong
copyleft properties that do not match the rest of the project. It is
set as a non-transitive dependency to avoid inadvertently pulling it
into downstream projects. In the future hydra should have pluggable
storage with multiple implementations.

The `hydra-uber` module builds an `exec` jar containing hydra and all
of it's dependencies. To include BDB JE when building with `mvn
package` use `-P bdbje`. The main class of the `exec` jar launches
the various components of a hydra cluster by name.

## System dependencies

JDK 7 is required. Hydra has been developed on Linux (Centos 6) and
should work on any modern Linux distro. Other unix-like systems
should work with minor changes but have not been tested. Mac OSX
should work for building and running local-stack (see below).

Hydra uses [rabbitmq](http://www.rabbitmq.com/) for low volume
command and control message exchange. On a modern Linux systems
`apt-get install rabbitmq-server` and running with the default
settings is adequate in most cases.

To run efficiently Hydra needs a mechanism to take copy on write
backups of the output of jobs. The is currently accomplished by
adding the [fl-cow](http://xmailserver.org/flcow.html) library to
`LD_PRELOAD`. Experimenting with other approaches such as ZFS or `cp
--reflink` are under consideration.

Many components assume that there is a local user called `hydra` and
that all minion nodes can ssh as that user to each other. This is
used most prominently for `rsync` based replicas.


## Components

While hydra can be used for ad-hoc analysis of csv and other local
files, it's most commonly used in a distributed cluster. In that case
the following components are involved:

* [ZooKeeper](http://zookeeper.apache.org/)
* Spawn: Job control and execution
* Minion: Task runner
* QueryMaster: Handler for queries
* QueryWorker: Handle scatter-gather requests from QueryMaster
* Meshy: File server

A typical configuration is to have a cluster head with Spawn &
QueryMaster backed by a homogeneous clusters of nodes running Minion,
QueryWorker, and Meshy.

## Local Stack

For local development all of the above components can run together in
a single stack run out of `hydra-local`. There is a `local-stack.sh`
script to assist with this. To run the local stack:

* You must be able to build hydra
* Have rabbitmq installed
* Allow your current user to ssh to itself

The first time the script is run a `hydra-local` directory will be created.

* `./hydra-uber/bin/local-stack.sh start` - start ZooKeeper
* `./hydra-uber/bin/local-stack.sh start` - start spawn, querymaster etc.
* `./hydra-uber/bin/local-stack.sh seed` - add some sample data

You can then navigate to http://localhost:5052/ and you should see
the spawn web interface.

When done `./hydra-uber/bin/local-stack.sh stop` will stop everything
except ZooKeeper, and running `stop` a second time will bring that
process down as well.

There are sample job configurations located in `hydra-uber/local/sample/`

## Administrative

### Discussion

Mailing list: http://groups.google.com/group/hydra-oss

[Freenode](http://freenode.net/) channel: `#hydra`

### Versioning

It's x.y.z where:

* x: Something Big Happened
* y: next release
* z: strive for bug fix only

### License

hydra is released under the Apache License Version 2.0. See
[Apache](http://www.apache.org/licenses/LICENSE-2.0) or the LICENSE
file in this distribution for details.




0 comments on commit 4dc2708

Please sign in to comment.