Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apache/incubator-pulsar

Apache Pulsar - distributed pub-sub messaging system
https://github.com/apache/incubator-pulsar

event-streaming messaging pubsub pulsar queuing streaming

Last synced: about 1 month ago
JSON representation

Apache Pulsar - distributed pub-sub messaging system

Host: GitHub
URL: https://github.com/apache/incubator-pulsar
Owner: apache
License: apache-2.0
Created: 2016-06-28T07:00:03.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-07-06T12:41:34.000Z (2 months ago)
Last Synced: 2024-07-07T10:05:15.338Z (2 months ago)
Topics: event-streaming, messaging, pubsub, pulsar, queuing, streaming
Language: Java
Homepage: https://pulsar.apache.org/
Size: 208 MB
Stars: 13,950
Watchers: 405
Forks: 3,531
Open Issues: 1,353
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-kafka - Pulsar
starred-awesome - incubator-pulsar - Pulsar - distributed pub-sub messaging system (Java)
awesome-streaming - Apache Pulsar - distributed pub-sub messaging platform with a very flexible messaging model and an intuitive client API. (Table of Contents / Data Pipeline)
awesome-streaming - Apache Pulsar - distributed pub-sub messaging platform with a very flexible messaging model and an intuitive client API. (Table of Contents / Data Pipeline)

README

        

![logo](https://pulsar.apache.org/img/pulsar.svg)

[![docker pull](https://img.shields.io/docker/pulls/apachepulsar/pulsar-all.svg)](https://hub.docker.com/r/apachepulsar/pulsar)

[![contributors](https://img.shields.io/github/contributors-anon/apache/pulsar)](https://github.com/apache/pulsar/graphs/contributors)

[![last commit](https://img.shields.io/github/last-commit/apache/pulsar)](https://github.com/apache/pulsar/commits/master)

[![release](https://img.shields.io/github/v/release/apache/pulsar?sort=semver)](https://pulsar.apache.org/download/)

[![downloads](https://img.shields.io/github/downloads/apache/pulsar/total)](https://pulsar.apache.org/download/)

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

- 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

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](https://github.com/apache/pulsar)

### Helm Chart

- [Pulsar Helm Chart](https://github.com/apache/pulsar-helm-chart)

### Ecosystem

- [Pulsar Adapters](https://github.com/apache/pulsar-adapters)

### Clients

- [.NET/C# Client](https://github.com/apache/pulsar-dotpulsar)

- [C++ Client](https://github.com/apache/pulsar-client-cpp)

- [Go Client](https://github.com/apache/pulsar-client-go)

- [NodeJS Client](https://github.com/apache/pulsar-client-node)

- [Python Client](https://github.com/apache/pulsar-client-python)

- [Reactive Java Client](https://github.com/apache/pulsar-client-reactive)

### Dashboard & Management Tools

- [Pulsar Manager](https://github.com/apache/pulsar-manager)

### Website

- [Pulsar Site](https://github.com/apache/pulsar-site)

### CI/CD

- [Pulsar CI](https://github.com/apache/pulsar-test-infra)

### Archived/Halted

- [Pulsar Connectors](https://github.com/apache/pulsar-connectors) (bundled as [pulsar-io](pulsar-io))

- [Pulsar Translation](https://github.com/apache/pulsar-translation)

- [Pulsar SQL (Pulsar Presto Connector)](https://github.com/apache/pulsar-presto) (bundled as [pulsar-sql](pulsar-sql))

- [Ruby Client](https://github.com/apache/pulsar-client-ruby)

## Pulsar Runtime Java Version Recommendation

- pulsar ver > 2.10 and master branch

| Components     | Java Version  |

|----------------|:-------------:|

| Broker         |      17       |

| Functions / IO |      17       |

| CLI            |      17       |

| Java Client    | 8 or 11 or 17 |

- 2.8 <= pulsar ver <= 2.10

| Components     | Java Version |

|----------------|:------------:|

| Broker         |      11      |

| Functions / IO |      11      |

| CLI            |   8 or 11    |

| Java Client    |   8 or 11    |

- pulsar ver < 2.8

| Components | Java Version |

|------------|:------------:|

| All        |   8 or 11    |

## Build Pulsar

### Requirements

- JDK

    | Pulsar Version    |                    JDK Version                    |

    |-------------------|:-------------------------------------------------:|

    | master and 2.11 + | [JDK 17](https://adoptium.net/?variant=openjdk17) |

    | 2.8 / 2.9 / 2.10  | [JDK 11](https://adoptium.net/?variant=openjdk11) |

    | 2.7 -             |  [JDK 8](https://adoptium.net/?variant=openjdk8)  |

- Maven 3.6.1+

- zip

> **Note**:

>

> This project includes a [Maven Wrapper](https://maven.apache.org/wrapper/) that can be used instead of a system-installed Maven.

> Use it by replacing `mvn` by `./mvnw` on Linux and `mvnw.cmd` on Windows in the commands below.    

### Build

Compile and install:

```bash

$ mvn install -DskipTests

```

Compile and install individual module

```bash

$ mvn -pl module-name (e.g: pulsar-broker) install -DskipTests

```

### Minimal build (This skips most of external connectors and tiered storage handlers)

```bash

mvn install -Pcore-modules,-main -DskipTests

```

Run Unit Tests:

```bash

$ mvn test

```

Run Individual Unit Test:

```bash

$ mvn -pl module-name (e.g: pulsar-client) test -Dtest=unit-test-name (e.g: ConsumerBuilderImplTest)

```

Run Selected Test packages:

```bash

$ mvn test -pl module-name (for example, pulsar-broker) -Dinclude=org/apache/pulsar/**/*.java

```

Start standalone Pulsar service:

```bash

$ bin/pulsar standalone

```

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

## Build custom docker images

The commands used in the Apache Pulsar release process can be found in the [release process documentation](https://pulsar.apache.org/contribute/release-process/#stage-docker-images).

Here are some general instructions for building custom docker images:

* Docker images must be built with Java 8 for `branch-2.7` or previous branches because of [ISSUE-8445](https://github.com/apache/pulsar/issues/8445).

* Java 11 is the recommended JDK version in `branch-2.8`, `branch-2.9` and `branch-2.10`.

* Java 17 is the recommended JDK version in `master`.

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

```bash

mvn clean install -DskipTests

# setting DOCKER_CLI_EXPERIMENTAL=enabled is required in some environments with older docker versions

export DOCKER_CLI_EXPERIMENTAL=enabled

mvn package -Pdocker,-main -am -pl docker/pulsar-all -DskipTests

```

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`.

```bash

image_repo_and_project=localhost:32000/apachepulsar

pulsar_version=$(mvn initialize help:evaluate -Dexpression=project.version -pl . -q -DforceStdout)

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

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

## Documentation

> **Note**:

>

> For how to make contributions to Pulsar documentation, see [Pulsar Documentation Contribution Guide](https://pulsar.apache.org/contribute/document-intro/).

## Contact

##### Mailing lists

| Name                                                      | Scope                           | Subscribe                                             | Unsubscribe                                               | Archives                                                           |

|:----------------------------------------------------------|:--------------------------------|:------------------------------------------------------|:----------------------------------------------------------|:-------------------------------------------------------------------|

| [[email protected]](mailto:[email protected]) | User-related discussions        | [Subscribe](mailto:[email protected]) | [Unsubscribe](mailto:[email protected]) | [Archives](http://mail-archives.apache.org/mod_mbox/pulsar-users/) |

| [[email protected]](mailto:[email protected])     | Development-related discussions | [Subscribe](mailto:[email protected])   | [Unsubscribe](mailto:[email protected])   | [Archives](http://mail-archives.apache.org/mod_mbox/pulsar-dev/)   |

##### 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

If you find a security issue with Pulsar then please [read the security policy](https://pulsar.apache.org/security/#security-policy). It is critical to avoid public disclosure.

### Reporting a security vulnerability

To report a vulnerability for Pulsar, contact the [Apache Security Team](https://www.apache.org/security/). When reporting a vulnerability to [[email protected]](mailto:[email protected]), you can copy your email to [[email protected]](mailto:[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

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

## Crypto Notice

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](http://www.wassenaar.org/) 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.