Repository: apache/pulsar

Stars: 15201

README.md Copy Chapter

<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->

!logo


Pulsar is a distributed pub-sub messaging platform with a very
flexible messaging model and an intuitive client API.

Learn more about Pulsar at https://pulsar.apache.org

Main features Copy Chapter

- Horizontally scalable (Millions of independent topics and millions
of messages published per second)
- Strong ordering and consistency guarantees
- Low latency durable storage
- Topic and queue semantics
- Load balancer
- Designed for being deployed as a hosted service:
- Multi-tenant
- Authentication
- Authorization
- Quotas
- Support mixing very different workloads
- Optional hardware isolation
- Keeps track of consumer cursor position
- REST API for provisioning, admin and stats
- Geo replication
- Transparent handling of partitioned topics
- Transparent batching of messages

Repositories Copy Chapter

This repository is the main repository of Apache Pulsar. Pulsar PMC also maintains other repositories for
components in the Pulsar ecosystem, including connectors, adapters, and other language clients.

- Pulsar Core

Helm Chart Copy Section

- Pulsar Helm Chart

Ecosystem Copy Section

- Pulsar Adapters

Clients Copy Section

- .NET/C# Client
- C++ Client
- Go Client
- NodeJS Client
- Python Client
- Reactive Java Client

Dashboard & Management Tools Copy Section

- Dekaf UI
- Pulsar Manager

Website Copy Section

- Pulsar Site

CI/CD Copy Section

- Pulsar CI

Archived/Halted Copy Section

- Pulsar Connectors (bundled as pulsar-io)
- Pulsar Translation
- Pulsar SQL (Pulsar Presto Connector) (bundled as pulsar-sql)
- Ruby Client

Pulsar Runtime Java Version Recommendation Copy Chapter

Note:

> When using Java versions, it is recommended to

use a recent version of a particular Java release (17 or 21)

with the most recent bug fixes and security patches.

For example, the JVM bug JDK-8351933 can cause stability issues in

Pulsar.

JDK-8351933 was fixed in Java 17.0.17+ and Java 21.0.8+.

Pulsar Docker images come with the most recent Java version at the time of release.

When using the Pulsar Java client, it is recommended to set specific system properties and JVM options to allow optimal performance.

pulsar ver >= 4.1 and master branch Copy Section

| Component | Java Version |
|-----------------|:------------:|
| Broker | 21 |
| Functions / IO | 21 |
| CLI | 17 or 21 |
| Java Client | 17 or 21 |

Docker image Java runtime: 21

3.3 <= pulsar ver <= 4.0 Copy Section

| Component | Java Version |
|-----------------|:---------------:|
| Broker | 21 |
| Functions / IO | 21 |
| CLI | 17 or 21 |
| Java Client | 8, 11, 17 or 21 |

Docker image Java runtime: 21

2.10 <= pulsar ver <= 3.0 Copy Section

| Component | Java Version |
|----------------|:-------------:|
| Broker | 17 |
| Functions / IO | 17 |
| CLI | 17 |
| Java Client | 8 or 11 or 17 |

Docker image Java runtime: 17

2.8 <= pulsar ver <= 2.10 Copy Section

| Component | Java Version |
|-----------------|:------------:|
| Broker | 11 |
| Functions / IO | 11 |
| CLI | 8 or 11 |
| Java Client | 8 or 11 |

pulsar ver < 2.8 Copy Section

| Component | Java Version |
|-------------|:------------:|
| All | 8 or 11 |

Build Pulsar Copy Chapter

Requirements Copy Section

- JDK

| Pulsar Version | JDK Version |
|------------------|:--------------------------------------------------------------------------------:|
| master | JDK 21 or JDK 25 |
| 4.0+ | JDK 21 |
| 2.11 + | JDK 17 |
| 2.8 / 2.9 / 2.10 | JDK 11 |
| 2.7 - | JDK 8 |

- zip

There is also a guide for setting up the tooling for building Pulsar.

Note:

> This project includes a Gradle Wrapper so no separate Gradle installation is needed.

Use ./gradlew on Linux/macOS and gradlew.bat on Windows.

> For a better developer experience, install Gradle command-line completion (gradle-completion installation) for bash and zsh shells.

Build Copy Section

Compile and assemble:

./gradlew assemble

Check source code license headers and formatting:

./gradlew rat spotlessCheck checkstyleMain checkstyleTest

Compile and assemble individual module:

./gradlew :pulsar-broker:assemble

Run Unit Tests:

./gradlew test

Run Individual Unit Test:

./gradlew :pulsar-client-original:test --tests "ConsumerBuilderImplTest"

Run Selected Test packages:

./gradlew :pulsar-broker:test --tests "org.apache.pulsar.*"

Start standalone Pulsar service:

$ bin/pulsar standalone

Check https://pulsar.apache.org for documentation and examples.

Build custom docker images Copy Chapter

The commands used in the Apache Pulsar release process can be found in the release process documentation.

Here are some general instructions for building custom docker images:

* Java 21 is the recommended JDK version since branch-4.0.

The following command builds the docker images apachepulsar/pulsar-all:latest and apachepulsar/pulsar:latest:

./gradlew docker-all

After the images are built, they can be tagged and pushed to your custom repository. Here's an example of a bash script that tags the docker images with the current version and git revision and pushes them to localhost:32000/apachepulsar.

image_repo_and_project=localhost:32000/apachepulsar
pulsar_version=$(src/get-pulsar-version.sh)
gitrev=$(git rev-parse HEAD | colrm 10)
tag="${pulsar_version}-${gitrev}"
echo "Using tag $tag"
docker tag apachepulsar/pulsar-all:latest ${image_repo_and_project}/pulsar-all:$tag
docker push ${image_repo_and_project}/pulsar-all:$tag
docker tag apachepulsar/pulsar:latest ${image_repo_and_project}/pulsar:$tag
docker push ${image_repo_and_project}/pulsar:$tag

Setting up your IDE Copy Chapter

Read https://pulsar.apache.org/contribute/setup-ide for setting up IntelliJ IDEA or Eclipse for developing Pulsar.

Documentation Copy Chapter

Note:

> For how to make contributions to Pulsar documentation, see Pulsar Documentation Contribution Guide.

Contact Copy Chapter

##### Mailing lists

* The mailing lists are the primary contact for the Apache Pulsar project.
* Your email to the mailing list might be placed in a moderation queue if you haven't joined the mailing list by subscribing before posting.

Note

> Please note that security-related issues or concerns should not be reported in public channels.

Follow the instructions in the Security Policy to contact the ASF Security Team and the Apache Pulsar PMC directly.

| Name | Scope | Subscribe | Unsubscribe | Archives |
|:----------------------------------------------------------|:--------------------------------|:------------------------------------------------------|:----------------------------------------------------------|:-------------------------------------------------------------------|
| [email protected] | User-related discussions | Subscribe | Unsubscribe | Archives |
| [email protected] | Development-related discussions | Subscribe | Unsubscribe | Archives |

##### Slack

Pulsar slack channel at https://apache-pulsar.slack.com/

You can self-register at https://communityinviter.com/apps/apache-pulsar/apache-pulsar

Security Policy Copy Chapter

If you find a security issue with Pulsar then please read the security policy. It is critical to avoid public disclosure.

Reporting a security vulnerability Copy Section

To report a vulnerability for Pulsar, contact the Apache Security Team. When reporting a vulnerability to [email protected], you can copy your email to [email protected] to send your report to the Apache Pulsar Project Management Committee. This is a private mailing list.

https://github.com/apache/pulsar/security/policy contains more details.

License Copy Chapter

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Crypto Notice Copy Chapter

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See The Wassenaar Arrangement for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software: Pulsar uses the SSL library from Bouncy Castle written by http://www.bouncycastle.org.