Pulsar dashboard is deprecated. If you want to manage and monitor the stats of your topics, use Pulsar Manager.
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.
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.8.1
You can find 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 running Pulsar standalone. The ip address or hostname should be accessible from the docker instance running dashboard.
Once the Docker container runs, the web dashboard is accessible via
localhost or whichever host that Docker uses.
SERVICE_URLthat the dashboard uses needs to be reachable from inside the Docker container
If the Pulsar service runs in standalone mode in
SERVICE_URL has to
be the IP 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. For example:
bin/pulsar standalone --advertised-address 220.127.116.11
Currently, only Pulsar Token authentication is supported.