Pulsar dashboard

note

Pulsar dashboard is deprecated. We recommend you use Pulsar Manager to manage and monitor the stats of your topics.

Pulsar dashboard is a web application that enables users to monitor current stats for all topics in tabular form.

The dashboard is a data collector that polls stats from all the brokers in a Pulsar instance (across multiple clusters) and stores all the information in a PostgreSQL database.

You can use the Django web app to render the collected data.

Install

The easiest way to use the dashboard is to run it inside a Docker container.

$ SERVICE_URL=http://broker.example.com:8080/
$ docker run -p 80:80 \
  -e SERVICE_URL=$SERVICE_URL \
  apachepulsar/pulsar-dashboard:2.2.1

You can find the Dockerfile in the dashboard directory and build an image from scratch as well:

$ docker build -t apachepulsar/pulsar-dashboard dashboard

If token authentication is enabled:

Provided token should have super-user access.

$ SERVICE_URL=http://broker.example.com:8080/
$ JWT_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
$ docker run -p 80:80 \
  -e SERVICE_URL=$SERVICE_URL \
  -e JWT_TOKEN=$JWT_TOKEN \
  apachepulsar/pulsar-dashboard

You need to specify only one service URL for a Pulsar cluster. Internally, the collector figures out all the existing clusters and the brokers from where it needs to pull the metrics. If you connect the dashboard to Pulsar running in standalone mode, the URL is http://<broker-ip>:8080 by default. <broker-ip> is the IP address or hostname of the machine that runs Pulsar standalone. The IP address or hostname should be accessible from the running dashboard in the docker instance.

Once the Docker container starts, the web dashboard is accessible via localhost or whichever host that Docker uses.

The SERVICE_URL that the dashboard uses needs to be reachable from inside the Docker container.

If the Pulsar service runs in standalone mode in localhost, the SERVICE_URL has to be the IP address of the machine.

Similarly, given the Pulsar standalone advertises itself with localhost by default, you need to explicitly set the advertise address to the host IP address. For example:

$ bin/pulsar standalone --advertised-address 1.2.3.4

Known issues

Currently, only Pulsar Token authentication is supported.