Try our Chrome extension
Easily add the current web-page from your browser directly into your changedetection.io tool, more great features coming soon!
Chrome Webstore
Changedetection.io needs your support!
You can help us by supporting changedetection.io on these platforms;
- Rate us at AlternativeTo.net
- Star us on GitHub
- Follow us at Twitter/X
- G2 Software reviews
- Check us out on LinkedIn
- And tell your friends and colleagues :)
The more popular changedetection.io is, the more time we can dedicate to adding amazing features!
Many thanks :)
changedetection.io team
Not yet seconds ago
False
Not yet seconds ago
Triggered text Ignored text Blocked text
10 hours ago
Skip to content
Navigation Menu
Sign in Appearance settings
* Platform
+ AI CODE CREATION
o GitHub Copilot Write better code with AI
o GitHub Copilot app Direct agents from issue to merge
o MCP Registry Integrate external tools
+ DEVELOPER WORKFLOWS
o Actions Automate any workflow
o Codespaces Instant dev environments
o Issues Plan and track work
o Code Review Manage code changes
o Code Quality Enforce quality at merge
+ APPLICATION SECURITY
o GitHub Advanced Security Find and fix vulnerabilities
o Code security Secure your code as you build
o Secret protection Stop leaks before they start
+ EXPLORE
o Why GitHub
o Documentation
o Blog
o Changelog
o Marketplace
View all features
* Solutions
+ BY COMPANY SIZE
o Enterprises
o Small and medium teams
o Startups
o Nonprofits
+ BY USE CASE
o App Modernization
o DevSecOps
o DevOps
o CI/CD
o View all use cases
+ BY INDUSTRY
o Healthcare
o Financial services
o Manufacturing
o Government
o View all industries
View all solutions
* Resources
+ EXPLORE BY TOPIC
o AI
o Software Development
o DevOps
o Security
o View all topics
+ EXPLORE BY TYPE
o Customer stories
o Events & webinars
o Ebooks & reports
o Business insights
o GitHub Skills
+ SUPPORT & SERVICES
o Documentation
o Customer support
o Community forum
o Trust center
o Partners
View all resources
* Open Source
+ COMMUNITY
o GitHub Sponsors Fund open source developers
+ PROGRAMS
o Security Lab
o Maintainer Community
o Accelerator
o GitHub Stars
o Archive Program
+ REPOSITORIES
o Topics
o Trending
o Collections
* Enterprise
+ ENTERPRISE SOLUTIONS
o Enterprise platform AI-powered developer platform
+ AVAILABLE ADD-ONS
o GitHub Advanced Security Enterprise-grade security features
o Copilot for Business Enterprise-grade AI features
o Premium Support Enterprise-grade 24/7 support
* Pricing
Type / to search
Sign in
Sign up Appearance settings
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Uh oh!
There was an error while loading. Please reload this page.
apache / kafka Public
* Notifications You must be signed in to change notification settings
* Fork 15.4k
* Star 33.5k
* Code
* Pull requests 507
* Actions
* Projects
* Security and quality 0
* Insights
Additional navigation options
* Code
* Pull requests
* Actions
* Projects
* Security and quality
* Insights
trunk
Branches Tags
Go to file
Code
Open more actions menu
Folders and files
Name Name Last commit message Last commit date
Latest commit
History
18,019 Commits
18,019 Commits
.github .github
api-checker api-checker
bin bin
checkstyle checkstyle
clients clients
committer-tools committer-tools
config config
connect connect
coordinator-common/ src coordinator-common/ src
core core
docker docker
docs docs
examples examples
generator/ src generator/ src
gradle gradle
group-coordinator group-coordinator
jmh-benchmarks jmh-benchmarks
licenses licenses
metadata metadata
raft raft
release release
server-common/ src server-common/ src
server/ src server/ src
share-coordinator/ src share-coordinator/ src
shell/ src shell/ src
storage storage
streams streams
test-common test-common
tests tests
tools tools
transaction-coordinator/ src transaction-coordinator/ src
trogdor trogdor
vagrant vagrant
.asf.yaml .asf.yaml
.gitignore .gitignore
AGENTS.md AGENTS.md
CONTRIBUTING.md CONTRIBUTING.md
HEADER HEADER
LICENSE LICENSE
LICENSE-binary LICENSE-binary
NOTICE NOTICE
NOTICE-binary NOTICE-binary
README.md README.md
SECURITY.md SECURITY.md
Vagrantfile Vagrantfile
build.gradle build.gradle
doap_Kafka.rdf doap_Kafka.rdf
gradle.properties gradle.properties
gradlew gradlew
gradlewAll gradlewAll
settings.gradle settings.gradle
wrapper.gradle wrapper.gradle
View all files
Repository files navigation
*
* README
* Code of conduct
* Contributing
* Apache-2.0 license
* Apache-2.0 license
* Security
More items
Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.
You need to have Java installed.
We build and test Apache Kafka with Java versions 17 and 25. The release parameter in javac is set to 11 for the clients and streams modules, and 17 for the rest, ensuring compatibility with their respective minimum Java versions. Similarly, the release parameter in scalac is set to 11 for the streams modules and 17 for the rest.
Scala 2.13 is the only supported version in Apache Kafka.
Build a JAR and run it
./gradlew jar
Follow instructions in https://kafka.apache.org/quickstart
Build source JAR
./gradlew srcJar
Build aggregated javadoc
./gradlew aggregatedJavadoc --no-parallel
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
./gradlew test -Pkafka.test.run.flaky=true # runs tests that are marked as flaky
Force re-running tests without code change
./gradlew test --rerun-tasks
./gradlew unitTest --rerun-tasks
./gradlew integrationTest --rerun-tasks
Running a particular unit/integration test
./gradlew clients:test --tests RequestResponseTest
./gradlew streams:integration-tests:test --tests RestoreIntegrationTest
Running a particular unit/integration test N times
N=500; I=0; while [ $I -lt $N ] && ./gradlew clients:test --tests RequestResponseTest --rerun --fail-fast; do (( I = $I + 1 )) ; echo " Completed run: $I " ; sleep 1; done
Running a particular test method within a unit/integration test
./gradlew clients:test --tests org.apache.kafka.clients.MetadataTest.testTimeToNextUpdate
./gradlew clients:clients-integration-tests:test --tests org.apache.kafka.clients.producer.ProducerFailureHandlingTest.testCannotSendToInternalTopic
./gradlew streams:integration-tests:test --tests org.apache.kafka.streams.integration.RestoreIntegrationTest.shouldRestoreNullRecord
Running a particular unit/integration test with log4j output
By default, there will be only a small number of logs output while testing. You can adjust it by changing the log4j2.yaml file in the module's src/test/resources directory.
For example, if you want to see more logs for clients project tests, you can modify the line in clients/src/test/resources/log4j2.yaml to level: INFO and then run:
./gradlew cleanTest clients:test --tests NetworkClientTest
And you should see INFO level logs in the file under the clients/build/test-results/test directory.
Specifying test retries
Retries are disabled by default, but you can set maxTestRetryFailures and maxTestRetries to enable retries.
The following example declares -PmaxTestRetries=1 and -PmaxTestRetryFailures=3 to enable a failed test to be retried once, with a total retry limit of 3.
./gradlew test -PmaxTestRetries=1 -PmaxTestRetryFailures=3
See Test Retry Gradle Plugin and build.yml for more details.
Generating test coverage reports
Generate coverage reports for the whole project:
./gradlew reportCoverage -PenableTestCoverage=true -Dorg.gradle.parallel=false
Generate coverage for a single module, i.e.:
./gradlew clients:reportCoverage -PenableTestCoverage=true -Dorg.gradle.parallel=false
Coverage reports are located within the module's build directory, categorized by module type:
Core Module (:core): core/build/reports/scoverageTest/index.html
Other Modules: <module>/build/reports/jacoco/test/html/index.html
Building a binary release gzipped tarball
./gradlew clean releaseTarGz
The release file can be found inside ./core/build/distributions/.
Building auto-generated messages
Sometimes it is only necessary to rebuild the RPC auto-generated message data when switching between branches, as they could fail due to code changes. You can just run:
./gradlew processMessages processTestMessages
See Apache Kafka Message Definitions for details on Apache Kafka message protocol.
Running a Kafka broker
Using compiled files:
KAFKA_CLUSTER_ID= " $( ./bin/kafka-storage.sh random-uuid ) "
./bin/kafka-storage.sh format --standalone -t $KAFKA_CLUSTER_ID -c config/server.properties
./bin/kafka-server-start.sh config/server.properties
Using docker image:
docker run -p 9092:9092 apache/kafka:latest
See docker/README.md for detailed information.
Cleaning the build
./gradlew clean
Running a task for a specific project
This is for core, examples and clients
./gradlew core:jar
./gradlew core:test
Streams has multiple sub-projects, but you can run all the tests:
./gradlew :streams:testAll
Listing all gradle tasks
./gradlew tasks
Building IDE project
Note: Please ensure that JDK 17 is used when developing Kafka.
IntelliJ supports Gradle natively, and it will automatically check Java syntax and compatibility for each module, even if the Java version shown in the Structure > Project Settings > Modules may not be the correct one.
When it comes to Eclipse, run:
./gradlew eclipse
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 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 all projects to the local Maven repository
./gradlew -PskipSigning=true publishToMavenLocal
Installing specific projects to the local Maven repository
./gradlew -PskipSigning=true :streams:publishToMavenLocal
Building the test JAR
./gradlew testJar
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 spotlessCheck
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 printed to the console. The build will fail if Checkstyle fails. For experiments (or regression testing purposes) add -PcheckstyleVersion=X.y.z switch (to override project-defined checkstyle version).
Spotless
The import order is a part of static check. Please call spotlessApply to optimize Java imports before filing a pull request.
./gradlew spotlessApply
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.
JMH microbenchmarks
We use JMH to write microbenchmarks that produce reliable results in the JVM.
See jmh-benchmarks/README.md for details on how to run the microbenchmarks.
Dependency Analysis
The gradle dependency debugging documentation mentions using the dependencies or dependencyInsight tasks to debug dependencies for the root project or individual subprojects.
Alternatively, use the allDeps or allDepInsight tasks for recursively iterating through all subprojects:
./gradlew allDeps
./gradlew allDepInsight --configuration runtimeClasspath --dependency com.fasterxml.jackson.core:jackson-databind
These take the same arguments as the built-in variants.
Determining if any dependencies could be updated
./gradlew dependencyUpdates
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: maximum number of test processes to start in parallel. Defaults to the number of processors available to the JVM.
* maxScalacThreads: maximum number of worker threads for the scalac backend. Defaults to the lowest of 8 and the number of processors available to the JVM. The value must be between 1 and 16 (inclusive).
* ignoreFailures: ignore test failures from junit
* showStandardStreams: shows standard output 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.
* maxTestRetries: maximum number of retries for a failing test case.
* maxTestRetryFailures: maximum number of test failures before retrying is disabled for subsequent tests.
* enableTestCoverage: enables test coverage plugins and tasks, including bytecode enhancement of classes required to track said coverage. Note that this introduces some overhead when running tests and hence why it's disabled by default (the overhead varies, but 15-20% is a reasonable estimate).
* keepAliveMode: configures the keep-alive mode for the Gradle compilation daemon - reuse improves start-up time. The values should be one of daemon or session (the default is daemon). daemon keeps the daemon alive until it's explicitly stopped while session keeps it alive until the end of the build session. This currently only affects the Scala compiler, see gradle/gradle#21034 for a PR that attempts to do the same for the Java compiler.
* scalaOptimizerMode: configures the optimizing behavior of the Scala compiler, the value should be one of none, method, inline-kafka or inline-scala (the default is inline-kafka). none is the Scala compiler default, which only eliminates unreachable code. method also includes method-local optimizations. inline-kafka adds inlining of methods within the kafka packages. Finally, inline-scala also includes inlining of methods within the scala library (which avoids lambda allocations for methods like Option.exists). inline-scala is only safe if the Scala library version is the same at compile time and runtime. Since we cannot guarantee this for all cases (for example, users may depend on the kafka jar for integration tests where they may include a scala library with a different version), we don't enable it by default. See https://www.lightbend.com/blog/scala-inliner-optimizer for more details.
Upgrading Gradle version
See gradle/wrapper/README.md for instructions on upgrading the Gradle version.
Running system tests
See tests/README.md.
Using Trogdor for testing
We use Trogdor as a test framework for Apache Kafka. You can use it to run benchmarks and other workloads.
See trogdor/README.md.
Running in Vagrant
See vagrant/README.md.
Kafka client examples
See examples/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:
* https://kafka.apache.org/contributing.html
About
Apache Kafka - A distributed event streaming platform
kafka.apache.org/
Topics
javakafkascalastreaming
Resources
Readme
Apache-2.0, Apache-2.0 licenses found
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
33.5k stars
Watchers
1.0k watching
Forks
15.4k forks
Report repository
Releases
Packages
Used by
Contributors
Languages
Footer
© 2026 GitHub, Inc.
Footer navigation
* Terms
* Privacy
* Security
* Status
* Community
* Docs
* Contact
* Manage cookies
* Do not share my personal information
You can’t perform that action at this time.
For now, Differences are performed on text, not graphically, only the latest screenshot is available.
Screenshot requires a Content Fetcher ( Sockpuppetbrowser, selenium, etc ) that supports screenshots.