Mirror of Apache Gearpump (Incubating)
Clone or download
manuzhang [GEARPUMP-305][Doc] Use MkDocs plugin to validate html
Get rid of ruby tools

Author: manuzhang <owenzhang1990@gmail.com>

Closes #252 from manuzhang/html_proofer.
Latest commit 7bc1a50 Aug 27, 2018
Permalink
Failed to load latest commit information.
.github [GEARPUMP-229] Add GitHub pull request template Dec 6, 2016
bin fixes GEARPUMP-159 Prep for first release Jun 30, 2016
conf [GEARPUMP-277] Allow user to configure retry times on app failure Feb 22, 2017
core/src [GEARPUMP-326] Upgrade Akka to 2.5.13 Jun 25, 2018
dev-tools [GEARPUMP-243] Add missing license headers and DISCLAIMER Dec 3, 2016
docs [GEARPUMP-305][Doc] Use MkDocs plugin to validate html Aug 27, 2018
examples [GEARPUMP-377] Add TwitterSource and examples May 8, 2018
experiments [GEARPUMP-368] Add dedicated trait for commands Apr 29, 2018
external [GEARPUMP-377] Add TwitterSource and examples May 8, 2018
gearpump-hadoop/src/main [GEARPUMP-366] Create JarStore dir if not exists on job submit Mar 16, 2018
integrationtest [GEARPUMP-361] Build gearpump docker image locally Dec 9, 2017
licenses [GEARPUMP-325] Fix license issues Jul 17, 2017
project [GEARPUMP-326] Upgrade Akka to 2.5.13 Jun 25, 2018
services [GEARPUMP-349] Optimize Graph topologicalOrderIterator performance Sep 18, 2017
streaming/src [GEARPUMP-339] Fix unknown tag parameter Apr 22, 2018
unmanagedlibs GEARPUMP-11, fix code style Apr 26, 2016
yarnconf GEARPUMP-11, fix code style Apr 26, 2016
.coveragerc fix #132 add codecov config Dec 25, 2014
.gitignore [GEARPUMP-327] Put jarstore and logs under "gearpump.home" Jul 21, 2017
.rat-excludes [GEARPUMP-183] fix licenses Jul 30, 2016
.sbtopts GEARPUMP-9, Clean and fix integration test Apr 26, 2016
.travis.yml [GEARPUMP-341] Update processing watermark in DataSinkTask Aug 16, 2017
CONTRIBUTING.md GEARPUMP-244 Fixed the broken link of IDE setup guide Dec 5, 2016
DISCLAIMER Add disclaimer Jul 15, 2016
KEYS fixes GEARPUMP-159 Prep for first release Jun 30, 2016
LICENSE [GEARPUMP-325] Fix license issues Jul 17, 2017
LICENSE.bin [GEARPUMP-325] Fix license issues Jul 17, 2017
NOTICE [GEARPUMP-243] Add missing license headers and DISCLAIMER Dec 3, 2016
README.md [GEARPUMP-344] Fix broken links in README Mar 16, 2018
ReleaseProcess.md [GEARPUMP-293] Remove CHANGELOG.md Mar 17, 2017
codecov.yml fix GEARPUMP-108 enable travis CI for Gearpump's apache repository May 5, 2016
jvm.sbt GEARPUMP-11, fix code style Apr 26, 2016
pubring.asc fix #359, Allow travis to auto publish signed artifacts to nexus sona… Jan 27, 2015
scalastyle-config.xml GEARPUMP-11, fix code style Apr 26, 2016
secring.asc.enc fix #359, Allow travis to auto publish signed artifacts to nexus sona… Jan 27, 2015
version.sbt Bump up version to 0.8.5-SNAPSHOT Jul 14, 2017

README.md

Apache Gearpump (incubating) Maven Central GitHub license Build Status codecov.io

Gearpump is a lightweight real-time big data streaming engine. It is inspired by recent advances in the Akka framework and a desire to improve on existing streaming frameworks.

The name Gearpump is a reference to the engineering term "gear pump", which is a super simple pump that consists of only two gears, but is very powerful at streaming water.

We model streaming within the Akka actor hierarchy.

Per initial benchmarks we are able to process near 18 million messages/second (100 bytes per message) with a 8ms latency on a 4-node cluster.

For steps to reproduce the performance test, please check Performance benchmark.

Useful Resources

How to Build

1). Clone the Gearpump repository

  git clone https://github.com/apache/incubator-gearpump.git
  cd gearpump

2). Build package

  ## Please use scala 2.11 or 2.10
  ## The target package path: output/target/gearpump-${version}.zip
  sbt clean +assembly +packArchiveZip

After the build, there will be a package file gearpump-${version}.zip generated under output/target/ folder.

To build scala document, use

   ## Will generate the scala doc under target/scala_2.xx/unidoc/
   sbt unidoc

NOTE: The build requires network connection. If you are behind an enterprise proxy, make sure you have set the proxy in your env before running the build commands. For windows:

set HTTP_PROXY=http://host:port
set HTTPS_PROXY= http://host:port

For Linux:

export HTTP_PROXY=http://host:port
export HTTPS_PROXY=http://host:port

How to run Gearpump integration test

Gearpump has an integration test system which is based on Docker. Please check the instructions.

How to do style check before submitting a pull request?

Before submitting a PR, you should always run style check first:

  ## Run style check for compile, test, and integration test.
  sbt scalastyle test:scalastyle it:scalastyle

How to generate the license report to generate a list of all dependencies

  sbt dumpLicenseReport

How to generate dependencies by declared license

  sbt dependencyLicenseInfo

Contributors (time order)

Contacts

License

Gearpump itself is licensed under the Apache License (2.0). For library it used, please see LICENSE.

Acknowledgement

The netty transport code work is based on Apache Storm. Thanks Apache Storm contributors.

The cgroup code work is based on JStorm. Thanks JStorm contributors.

Thanks to Jetbrains for providing a IntelliJ IDEA Free Open Source License.