https://github.com/nghialv/promviz

Visualize the traffic of your clusters in realtime from Prometheus data
https://github.com/nghialv/promviz

microservices monitoring prometheus promviz visualization vizceral

Last synced: about 2 months ago
JSON representation

Visualize the traffic of your clusters in realtime from Prometheus data

• Host: GitHub
• URL: https://github.com/nghialv/promviz
• Owner: nghialv
• License: mit
• Created: 2017-10-10T06:04:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-28T07:57:28.000Z (3 months ago)
• Last Synced: 2024-06-28T08:57:19.442Z (3 months ago)
• Topics: microservices, monitoring, prometheus, promviz, visualization, vizceral
• Language: Go
• Homepage:
• Size: 5.2 MB
• Stars: 951
• Watchers: 14
• Forks: 52
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Promviz [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com) [![MIT Licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nghialv/promviz/blob/master/LICENSE)

Promviz is an application that helps you visualize the traffic of your cluster from Prometheus data.

It has 2 components:

- Promviz: retrieves data from Prometheus servers, aggregates them and provides an API to get the graph data.

- [Promviz-front](https://github.com/mjhd-devlion/promviz-front): based on Netflix's [vizceral](https://github.com/Netflix/vizceral) to render traffic graph.

#### Features:

- Generates and renders traffic graph in realtime

- Able to replay from any time in the past

- Able to generate notices on node and connection from prom query

- Provides a sidecar application for k8s that watches config changes and reload Promviz server in runtime

- Fits with [Istio](https://istio.io)'s metrics

![](https://github.com/nghialv/promviz/blob/master/documentation/sample_filter.png)

## Architecture

![](https://github.com/nghialv/promviz/blob/master/documentation/architecture.png)

## Install

#### Helm chart

If you are using [Helm](https://helm.sh), the simplest way to install is using the charts in `helm` directory with

```

helm install --name promviz ./helm/promviz

helm install --name promviz-front ./helm/promviz-front

```

#### Docker images

Docker images of both `promviz` and `promviz-front` are available on Docker Hub.

- [ghcr.io/nghialv/promviz](https://github.com/nghialv/promviz/pkgs/container/promviz)

- [mjhddevlion/promviz-front](https://hub.docker.com/r/mjhddevlion/promviz-front)

## Example

I have already prepared 2 examples and put them in the `example` directory.

You can try it by going to that directory and run

```

docker-compose -f simple-compose.yaml up --build

```

or

```

docker-compose -f full-compose.yaml up --build

```

Then checkout each service at:

- promviz-front: [http://localhost:8080/graph](http://localhost:8080/)

- promviz: [http://localhost:9091/graph](http://localhost:9091/graph)

- prometheus: [http://localhost:9090/graph](http://localhost:9090/graph)

- mock-metric: [http://localhost:30001/metrics](http://localhost:30001/metrics)

## Configuration

See [configuration.md](https://github.com/nghialv/promviz/blob/master/documentation/configuration.md) in documentation directory.

## Contributing

Please feel free to create an issue or pull request.

## LICENSE

Promviz is released under the MIT license. See LICENSE file for details.