Mirror of Apache Kafka
Scala Java Python Shell Groovy
Pull request Compare This branch is 2381 commits behind apache:trunk.
Permalink
Failed to load latest commit information.
bin KAFKA-1291 Add wrapper scripts and usage information to each command. Jun 19, 2014
clients/src kafka-1533; transient unit test failure in ProducerFailureHandlingTes… Jul 22, 2014
config kafka-1531; zookeeper.connection.timeout.ms is set to 10000000 in con… Jul 16, 2014
contrib kafka-1406; Fix scaladoc/javadoc warnings; patched by Alan Lee; revie… Jul 10, 2014
core/src KAFKA-1544 Log cleaner takes a long time to shut down. Patch from Man… Jul 24, 2014
examples KAFKA-1254 remove vestigial sbt patch by Joe Stein; reviewed by Jun Rao Feb 20, 2014
gradle kafka-1171; Gradle build for Kafka; patched by David Arthur, Joe Stei… Feb 7, 2014
lib KAFKA-1254 remove vestigial sbt patch by Joe Stein; reviewed by Jun Rao Feb 20, 2014
system_test KAFKA-1438 Migrate client tools out of perf; reviewed by Neha Narkhede Jun 5, 2014
.gitignore kafka-1371; Ignore build output dirs; patched by Stevo Slavic; review… Apr 9, 2014
.rat-excludes KAFKA-151 Standard .rat-excludes file and rat script;patched by nehan… Oct 14, 2011
.reviewboardrc KAFKA-1053 Kafka patch review tool that integrates JIRA and reviewboa… Sep 18, 2013
HEADER trivial fix to add missing license header using .gradlew licenseForma… Feb 7, 2014
LICENSE KAFKA-1254 remove vestigial sbt patch by Joe Stein; reviewed by Jun Rao Feb 20, 2014
NOTICE KAFKA-533 changes to NOTICE and LICENSE related to KAFKA-534 removing… Sep 27, 2012
README.md KAFKA-1362; Publish sources and javadoc jars; (also removed Scala 2.8… Apr 18, 2014
build.gradle KAFKA-1308 Publish jar of test utilities to Maven Jul 2, 2014
doap_Kafka.rdf trivial change to add kafka doap project file Apr 12, 2014
gradle.properties KAFKA-1274 gradle.properties needs the variables used in the build.gr… Feb 19, 2014
gradlew kafka-1171; Gradle build for Kafka; patched by David Arthur, Joe Stei… Feb 7, 2014
gradlew.bat kafka-1370; Gradle startup script for Windows; patched by Stevo Slavi… Apr 9, 2014
kafka-patch-review.py KAFKA-1442 RBTools post-review is deprecated; reviewed by Neha Narkhede May 8, 2014
scala.gradle kafka-1244,kafka-1246,kafka-1249; various gradle issues for release; … Feb 12, 2014
settings.gradle kafka-1244,kafka-1246,kafka-1249; various gradle issues for release; … Feb 12, 2014

README.md

Apache Kafka

See our web site for details on the project.

Building a jar and running it

./gradlew jar  

Follow instuctions in http://kafka.apache.org/documentation.html#quickstart

Building source jar

./gradlew srcJar

Building javadocs and scaladocs

./gradlew javadoc
./gradlew javadocJar # builds a jar from the javadocs
./gradlew scaladoc
./gradlew scaladocJar # builds a jar from the scaladocs
./gradlew docsJar # builds both javadoc and scaladoc jar

Running unit tests

./gradlew test

Forcing re-running unit tests w/o code change

./gradlew cleanTest test

Running a particular unit test

./gradlew -Dtest.single=RequestResponseSerializationTest core:test

Running a particular unit test with log4j output

change the log4j setting in either clients/src/test/resources/log4j.properties or core/src/test/resources/log4j.properties
./gradlew -i -Dtest.single=RequestResponseSerializationTest core:test

Building a binary release gzipped tar ball

./gradlew clean
./gradlew releaseTarGz  
The above command will fail if you haven't set up the signing key. To bypass signing the artifact, you can run
./gradlew releaseTarGz -x signArchives

The release file can be found inside ./core/build/distributions/.

Cleaning the build

./gradlew clean

Running a task on a particular version of Scala (either 2.8.0, 2.8.2, 2.9.1, 2.9.2 or 2.10.1)

(If building a jar with a version other than 2.8.0, the scala version variable in bin/kafka-run-class.sh needs to be changed to run quick start.)

./gradlew -PscalaVersion=2.9.1 jar
./gradlew -PscalaVersion=2.9.1 test
./gradlew -PscalaVersion=2.9.1 releaseTarGz

Running a task for a specific project

This is for 'core', 'perf', 'contrib:hadoop-consumer', 'contrib:hadoop-producer', 'examples' and 'clients' ./gradlew core:jar ./gradlew core:test

Listing all gradle tasks

./gradlew tasks

Building IDE project

./gradlew eclipse
./gradlew idea

Building the jar for all scala versions and for all projects

./gradlew jarAll

Running unit tests for all scala versions and for all projects

./gradlew testAll

Building a binary release gzipped tar ball for all scala versions

./gradlew releaseTarGzAll

Publishing the jar for all version of Scala and for all projects to maven

./gradlew uploadArchivesAll

Please note for this to work you should create/update ~/.gradle/gradle.properties and assign the following variables

mavenUrl=
mavenUsername=
mavenPassword=
signing.keyId=
signing.password=
signing.secretKeyRingFile=

Building the test jar

./gradlew testJar

Determining how transitive dependencies are added

./gradlew core:dependencies --configuration runtime

Contribution

Apache Kafka interested in building the community; we would welcome any thoughts or patches. You can reach us on the Apache mailing lists.

To contribute follow the instructions here:

We also welcome patches for the website and documentation which can be found here: