The Pulsar dashboard

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

A Django web app is used to render the collected data.

Install

The easiest way to use the dashboard is to run it inside a Docker container. A Dockerfile to generate the image is provided.

To generate the Docker image:

  1. $ docker build -t apachepulsar/pulsar-dashboard dashboard

To run the dashboard:

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

If token authentication is enabled:

Provided token should have super-user access.

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

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

Once the Docker container is running, the web dashboard will be accessible via localhost or whichever host is being used by Docker.

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

If the Pulsar service is running in standalone mode in localhost, the SERVICE_URL would have tobe the IP of the machine.

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

  1. $ bin/pulsar standalone --advertised-address 1.2.3.4

Known issues

Only Pulsar Token authentication is supported as of now.