Skip to content
Mirror of Apache Kafka
Java Scala Python Shell Batchfile XSLT
Branch: 2.3-li
Clone or download
Pull request Compare This branch is 212 commits ahead, 588 commits behind apache:trunk.
kidkun [LI-HOTFIX] Add support to use BoringSSL for SSL/TLS.
TICKET = KAFKA-2561
LI_DESCRIPTION =
Make Kafka capable of using BoringSSL for encryption.
EXIT_CRITERIA = TICKET [KAFKA-2561]
Latest commit 1a4c6fd Nov 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.githooks [LI-HOTFIX] add prepare-commit-msg hook to help format commit message ( Aug 27, 2019
bin [LI-HOTFIX] [ScalaConsumer] Added back the old Scala consumer code, w… Aug 20, 2019
checkstyle [LI-HOTFIX] Add support to use BoringSSL for SSL/TLS. Nov 11, 2019
clients [LI-HOTFIX] Add support to use BoringSSL for SSL/TLS. Nov 11, 2019
config KAFKA-3816: Add MDC logging to Connect runtime (apache#5743) May 16, 2019
connect [LI-CHERRY-PICK] [5b4e749] KAFKA-8391; Temporarily ignore flaky Conne… Aug 27, 2019
core [LI-HOTFIX] Add support to use BoringSSL for SSL/TLS. Nov 11, 2019
docs [LI-CHERRY-PICK] [6916e86] MINOR: Update documentation for enabling o… Aug 21, 2019
examples [LI-HOTFIX] [ScalaConsumer] Added back the old Scala consumer code, w… Aug 20, 2019
generator/src HOTFIX: Fix recent protocol breakage from KIP-345 and KIP-392 (apache… May 22, 2019
gradle [LI-HOTFIX] Add support to use BoringSSL for SSL/TLS. Nov 11, 2019
jmh-benchmarks MINOR: Document improvement (apache#6682) May 6, 2019
log4j-appender/src MINOR: Remove deprecated assertThat usage from KafkaLog4jAppenderTest ( Feb 12, 2019
streams [LI-CHERRY-PICK] [9100009] KAFKA-8824: bypass value serde on null (ap… Aug 27, 2019
tests [LI-CHERRY-PICK] [b85707c] KAFKA-8774: Regex can be found anywhere in… Aug 21, 2019
tools/src KAFKA-8225 & KIP-345 part-2: fencing static member instances with con… May 18, 2019
vagrant MINOR: Add 2.0, 2.1 and 2.2 to broker and client compat tests May 23, 2019
.gitignore [LI-HOTFIX] include gradle wrapper and ignore a failed unit test due … Aug 23, 2019
.travis.yml [LI-HOTFIX] fix hard coded travis tag (#57) Oct 13, 2019
CONTRIBUTING.md MINOR: Use https instead of http in links (apache#6477) Apr 22, 2019
HEADER trivial fix to add missing license header using .gradlew licenseForma… Feb 7, 2014
LICENSE KAFKA-4514; Add Codec for ZStandard Compression (apache#2267) Oct 10, 2018
NOTICE MINOR: Use https instead of http in links (apache#6477) Apr 22, 2019
PULL_REQUEST_TEMPLATE.md MINOR: Exclude Committer Checklist section from commit message Nov 10, 2017
README.md [LI-HOTFIX] add Bintray support to LinkedIn Kafka Github Aug 20, 2019
TROGDOR.md MINOR: Fix code section formatting in TROGDOR.md (apache#6720) May 11, 2019
Vagrantfile MINOR: upgrade to jdk8 8u202 Jan 25, 2019
build.gradle [LI-HOTFIX] Add support to use BoringSSL for SSL/TLS. Nov 11, 2019
doap_Kafka.rdf MINOR: Use https instead of http in links (apache#6477) Apr 22, 2019
gradle.properties [LI-HOTFIX] add Bintray support to LinkedIn Kafka Github Aug 20, 2019
gradlew [LI-HOTFIX] include gradle wrapper and ignore a failed unit test due … Aug 23, 2019
gradlew.bat [LI-HOTFIX] include gradle wrapper and ignore a failed unit test due … Aug 23, 2019
jenkins.sh MINOR: Add verification step for Streams archetype to Jenkins build (a… Mar 21, 2019
kafka-merge-pr.py Bump version to 2.3.1-SNAPSHOT Jun 24, 2019
release.py HOTFIX: Change header back to http instead of https to path license h… Feb 28, 2019
release_notes.py MINOR: Use https instead of http in links (apache#6477) Apr 22, 2019
settings.gradle KAFKA-8155: Add 2.2.0 release to system tests (apache#6597) Jun 4, 2019
wrapper.gradle KAFKA-1490 remove gradlew initial setup output from source distributi… Sep 23, 2014

README.md

LinkedIn Branch of Apache Kafka

This is the version of Kafka running at LinkedIn.

Kafka was born at LinkedIn. We run thousands of brokers to deliver trillions of messages per day. We run a slightly modified version of Apache Kafka trunk. This branch contains the LinkedIn Kafka release.

This branch is made up of:

  • Apache Kafka trunk (upstream) up to some branch point, see -li branch name for base version, you'll be able to get the exact commit from git
  • Cherry-picked commits from upstream after branch point
  • Patches that are on their way upstream but we have deployed internally in the meantime
  • Patches that are of no interest to upstream

We are making this branch available for people interested. We will be documenting the changes in the near future with some more detailed explanations in the LinkedIn Engineering Blog.

If you are interested in learning more, we invite you to our Streaming Meetup where we discuss streaming technologies like Kafka and Samza.

You are encouraged to check out other Kafka projects from LinkedIn:

Contributing

At this moment we are not accepting external contributions directly. Please contribute to Apache Kafka.

For security issues with this branch please review LinkedIn Security Guidelines. General Kafka issues should be communicated via the Kafka community.

Apache Kafka

See our web site for details on the project.

You need to have Gradle and Java installed.

Kafka requires Gradle 5.0 or higher.

Java 8 should be used for building in order to support both Java 8 and Java 11 at runtime.

Scala 2.12 is used by default, see below for how to use a different Scala version or all of the supported Scala versions.

First bootstrap and download the wrapper

cd kafka_source_dir
gradle

Now everything else will work.

Build a jar and run it

./gradlew jar

Follow instructions in https://kafka.apache.org/documentation.html#quickstart

Build source jar

./gradlew srcJar

Build aggregated javadoc

./gradlew aggregatedJavadoc

Build javadoc and scaladoc

./gradlew javadoc
./gradlew javadocJar # builds a javadoc jar for each module
./gradlew scaladoc
./gradlew scaladocJar # builds a scaladoc jar for each module
./gradlew docsJar # builds both (if applicable) javadoc and scaladoc jars for each module

Run unit/integration tests

./gradlew test # runs both unit and integration tests
./gradlew unitTest
./gradlew integrationTest

Force re-running tests without code change

./gradlew cleanTest test
./gradlew cleanTest unitTest
./gradlew cleanTest integrationTest

Running a particular unit/integration test

./gradlew clients:test --tests RequestResponseTest

Running a particular test method within a unit/integration test

./gradlew core:test --tests kafka.api.ProducerFailureHandlingTest.testCannotSendToInternalTopic
./gradlew clients:test --tests org.apache.kafka.clients.MetadataTest.testMetadataUpdateWaitTime

Running a particular unit/integration test with log4j output

Change the log4j setting in either clients/src/test/resources/log4j.properties or core/src/test/resources/log4j.properties

./gradlew clients:test --tests RequestResponseTest

Generating test coverage reports

Generate coverage reports for the whole project:

./gradlew reportCoverage

Generate coverage for a single module, i.e.:

./gradlew clients:reportCoverage

Building a binary release gzipped tar ball

./gradlew clean releaseTarGz

The above command will fail if you haven't set up the signing key. To bypass signing the artifact, you can run:

./gradlew clean releaseTarGz -x signArchives

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

Cleaning the build

./gradlew clean

Running a task with a particular version of Scala (either 2.11.x or 2.12.x)

Note that if building the jars with a version other than 2.12.x, you need to set the SCALA_VERSION variable or change it in bin/kafka-run-class.sh to run the quick start.

You can pass either the major version (eg 2.12) or the full version (eg 2.12.7):

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

Running a task with all scala versions

Append All to the task name:

./gradlew testAll
./gradlew jarAll
./gradlew releaseTarGzAll

Running a task for a specific project

This is for core, examples and clients

./gradlew core:jar
./gradlew core:test

Listing all gradle tasks

./gradlew tasks

Building IDE project

Note that this is not strictly necessary (IntelliJ IDEA has good built-in support for Gradle projects, for example).

./gradlew eclipse
./gradlew idea

The eclipse task has been configured to use ${project_dir}/build_eclipse as Eclipse's build directory. Eclipse's default build directory (${project_dir}/bin) clashes with Kafka's scripts directory and we don't use Gradle's build directory to avoid known issues with this configuration.

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

./gradlew -Pversion=<release version> uploadArchivesAll

By default, this command will publish artifacts to a Bintray repository named "kafka" under an account specified by the BINTRAY_USER environment variable. The BINTRAY_KEY environment variable is used for the password for that account.

If you want to override this to use a different maven repository, you should create/update ${GRADLE_USER_HOME}/gradle.properties (typically, ~/.gradle/gradle.properties) and assign the following variables

mavenUrl=
mavenUsername=
mavenPassword=

Signing is disabled by default. If you need signing, please set the following variables in gradle.properties as well:

signing.keyId=
signing.password=
signing.secretKeyRingFile=

Publishing the streams quickstart archetype artifact to maven

For the Streams archetype project, one cannot use gradle to upload to maven; instead the mvn deploy command needs to be called at the quickstart folder:

cd streams/quickstart
mvn deploy

Please note for this to work you should create/update user maven settings (typically, ${USER_HOME}/.m2/settings.xml) to assign the following variables

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                       https://maven.apache.org/xsd/settings-1.0.0.xsd">
...                           
<servers>
   ...
   <server>
      <id>apache.snapshots.https</id>
      <username>${maven_username}</username>
      <password>${maven_password}</password>
   </server>
   <server>
      <id>apache.releases.https</id>
      <username>${maven_username}</username>
      <password>${maven_password}</password>
    </server>
    ...
 </servers>
 ...

Installing the jars to the local Maven repository

./gradlew installAll

Building the test jar

./gradlew testJar

Determining how transitive dependencies are added

./gradlew core:dependencies --configuration runtime

Determining if any dependencies could be updated

./gradlew dependencyUpdates

Running code quality checks

There are two code quality analysis tools that we regularly run, spotbugs and checkstyle.

Checkstyle

Checkstyle enforces a consistent coding style in Kafka. You can run checkstyle using:

./gradlew checkstyleMain checkstyleTest

The checkstyle warnings will be found in reports/checkstyle/reports/main.html and reports/checkstyle/reports/test.html files in the subproject build directories. They are also are printed to the console. The build will fail if Checkstyle fails.

Spotbugs

Spotbugs uses static analysis to look for bugs in the code. You can run spotbugs using:

./gradlew spotbugsMain spotbugsTest -x test

The spotbugs warnings will be found in reports/spotbugs/main.html and reports/spotbugs/test.html files in the subproject build directories. Use -PxmlSpotBugsReport=true to generate an XML report instead of an HTML one.

Common build options

The following options should be set with a -P switch, for example ./gradlew -PmaxParallelForks=1 test.

  • commitId: sets the build commit ID as .git/HEAD might not be correct if there are local commits added for build purposes.
  • mavenUrl: sets the URL of the maven deployment repository (file://path/to/repo can be used to point to a local repository).
  • maxParallelForks: limits the maximum number of processes for each task.
  • showStandardStreams: shows standard out and standard error of the test JVM(s) on the console.
  • skipSigning: skips signing of artifacts.
  • testLoggingEvents: unit test events to be logged, separated by comma. For example ./gradlew -PtestLoggingEvents=started,passed,skipped,failed test.
  • xmlSpotBugsReport: enable XML reports for spotBugs. This also disables HTML reports as only one can be enabled at a time.

Running in Vagrant

See vagrant/README.md.

Contribution

Apache Kafka is 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:

You can’t perform that action at this time.