Hi all,

We have developed a new Pulsar web UI - pulsar-manager, aiming at
supporting managing Pulsar clusters running in different environments
(on-premise data centers, cloud, and so on). We’d like to contribute the
project back to the Pulsar community.

---

## Motivation

Currently, Pulsar has a monitoring tool - [Pulsar Dashboard]( [
http://pulsar.apache.org/docs/en/administration-dashboard/](http://pulsar.apache.org/docs/en/administration-dashboard/)
).
However, it only focuses on the simple monitoring of Pulsar - collecting
and displaying information such as statistics of tenants, namespaces,
topics, subscriptions, and so on. It doesn’t provide any management
operations such as add, delete and update tenants, namespaces, topics, and
so on. When the scale of Pulsar cluster increases or the number of clusters
grows, using `pulsar-admin` to manage Pulsar can not satisfy demands.
Therefore, Pulsar needs a simple and easy-to-use management console for
administrators.

Pulsar Manager is a web-based GUI management and monitoring tool that helps
administrators and users manage and monitor tenants, namespaces, topics,
subscriptions, brokers, clusters, and so on, and supports dynamic
configuration of multiple environments.

## Features

Pulsar manager provides two main features: management and monitoring.

### Management

1. Environment : (operations on the environment)
Create / Delete / Update / List / Get
2. Cluster : (operations on clusters)
Create / Delete / Update / List / Get
3. Brokers : (operations on brokers)
Heartbeat / Unload
4. Tenants:
Create / Delete / Update / List
5. Namespaces:
Create / Delete / List
Manage Namespace Policy
Unload
Operations on Namespace Bundles
6. Topics
Create / Delete / List
Unload / Terminate / Offload / Compact
Topic Details
7. Subscriptions
Create / Delete / List
Reset Cursor / Skip / Clear backlog / Unsubscribe
8. Namespace Isolation Policies
Create / Delete / Update / Get / List
9. Failure Domains
Create / Delete / Update / Get / List

### Monitoring: (display *aggregated* stats at different levels)

1. Tenants
List the total number of namespaces per tenant (both aggregated and
per-cluster basis)

2. Namespaces
List the total number of topics per namespace
List the aggregated stats per namespace (such as rate-in, rate-out,
throughput-in, and throughput-out)
List the distributions of namespace bundles

3. Topics
List the total number of partitions per topic
List the aggregated stats per topic (such as rate-in, rate-out,
throughput-in, and throughput-out)
Detailed stats per topic partition
Detailed stats of storage per topic partition
Detailed stats of subscription per topic and per partition
Detailed stats of producers
Detailed stats of consumers

The detailed design proposal is in
 [
https://docs.google.com/document/d/1C3meaHJzxX9wGDWQx-dC1b20yGeKsQtbwNiYuxZgOCE/edit#](https://docs.google.com/document/d/1C3meaHJzxX9wGDWQx-dC1b20yGeKsQtbwNiYuxZgOCE/edit#)

Looking forward to any feedback.

Thanks,
Guangning

Reply via email to