ggreer91 / PulsarPortrait

Pulsar

PulsarPortrait

https://pulsarportrait.io/

About

PulsarPortrait is an open-source application that illustrates the current health of your Pulsar cluster. By scraping data from Prometheus metrics, the app can display a variety of graphs, gauges, and counters. From message data to jetty response times, users can choose from eleven visualizations and frame them in any of the six display slots.

Getting Started

Option 1 - Add PulsarPortrait to your compose.yml file

Simply copy and paste the following code into the services dictionary of your compose.yml file. Please note that if your network is not pulsar, you will need to change it in the networks section of each service.

prometheus:
  image: pulsarportrait/prometheus:latest
  container_name: prometheus
  networks:
    - pulsar
  ports:
    - '9090:9090'

pulsarportrait:
  image: pulsarportrait/app:latest
  container_name: pulsarportrait
  networks:
    - pulsar
  ports:
    - '3333:3333'

grafana:
  image: pulsarportrait/grafana:latest
  container_name: grafana
  networks:
    - pulsar
  ports:
    - '2222:3000'
  depends_on:
    - prometheus

Option 2 - Use this repo

if you already have a project with Pulsar and do not wish to edit the compose.yml file, you can follow these steps:

• Fork and clone this repo
• Start your Pulsar culster
• In this repo, add your Pulsar cluster's network to the compose.yml file, if you are unsure of the name of your network, you can run docker network ls

• Lastly, run docker compose up -d, and PulsarPortrait will be available on http://localhost:3333/

Contributions

We welcome feedback and contributions to this project. If you want to add a feature or fix a bug, please follow these steps:

• Fork and clone this repo
• Create your feature branch by running

git checkout -b your-feature-branch-name

• Add, commit, and push your changes up to GitHub
• Lastly, make a pull request detailing your changes

Authors

• Grant Thomas GitHub | LinkedIn
• Cyrux Lam GitHub | LinkedIn
• Anthony Le GitHub | LinkedIn
• Jordan Zolman Github | LinkedIn

License

• PulsarPortrait is MIT Licensed