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.
To generate the Docker image:
docker build -t apachepulsar/pulsar-dashboard dashboard
To run the dashboard:
SERVICE_URL=http://broker.example.com:8080/ docker run -p 80:80 \ -e SERVICE_URL=$SERVICE_URL \ apachepulsar/pulsar-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 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.
SERVICE_URLthat the dashboard uses needs to be reachable from inside the Docker container
If the Pulsar service is running in standalone mode in
SERVICE_URL would have to be the IP of the machine.
Similarly, given the Pulsar standalone advertises itself with localhost by default, we need to explicitly set the advertise address to the host IP. For example:
bin/pulsar standalone --advertised-address 126.96.36.199
Only Pulsar Token authentication is supported as of now.