Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmnellis/vistio
Visualize your Istio mesh using Netflix's Vizceral
https://github.com/nmnellis/vistio
Last synced: about 2 months ago
JSON representation
Visualize your Istio mesh using Netflix's Vizceral
- Host: GitHub
- URL: https://github.com/nmnellis/vistio
- Owner: nmnellis
- License: mit
- Created: 2018-06-11T00:51:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-20T00:26:00.000Z (about 6 years ago)
- Last Synced: 2024-07-31T07:18:23.373Z (5 months ago)
- Language: JavaScript
- Size: 12.1 MB
- Stars: 373
- Watchers: 14
- Forks: 33
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - vistio - Visualize your Istio mesh using Netflix's Vizceral (JavaScript)
- awesome-istio - Vistio - Visualize your Istio mesh using Netflix's Vizceral. (Dashboard)
README
# Vistio [](https://circleci.com/gh/nmnellis/vistio) [](http://makeapullrequest.com) [](https://github.com/nmnellis/vistio/blob/master/LICENSE)
* [Features](#features)
* [Architecture](#architecture)
* [Docker images](#docker-images)
* [Deploy Vistio](#deploy-vistio)
+ [Deploy Vistio with Istio Ingress Gateway (kubectl)](#deploy-vistio-with-istio-ingress-gateway-kubectl)
+ [Deploy Vistio with Istio Ingress Gateway (helm)](#deploy-vistio-with-istio-ingress-gateway-helm)
+ [Deploy Vistio Without Istio Ingress (kubectl)](#deploy-vistio-without-istio-ingress-kubectl)
+ [Deploy Vistio Without Istio Ingress (Helm)](#deploy-vistio-without-istio-ingress-helm)
* [Configuration](#configuration)
* [docker-compose Example](#docker-compose-example)
* [Troubleshooting](#troubleshooting)
* [Releases](#releases)
* [Contributing](#contributing)
* [LICENSE](#license)
Table of contents generated with markdown-toc
* Forked from - https://github.com/nghialv/promviz and https://github.com/mjhd-devlion/promviz-front
Vistio is an application that helps you visualize the traffic of your cluster from Prometheus data.
It has 2 components:
- Vistio-API: retrieves data from Prometheus servers, aggregates them and provides an API to get the graph data.
- Vistio-Web: Forked from [Promviz-front](https://github.com/mjhd-devlion/promviz-front): based on Netflix's [vizceral](https://github.com/Netflix/vizceral) to render traffic graph.
## Updated for Istio 1.0
The helm charts have been updated to work with Istio 1.0
## 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 Vistio server in runtime
- Fits with [Istio](https://istio.io)'s metrics
## Architecture
## Docker images
Docker images of both `vistio-api` and `vistio-web` are available on Docker Hub.
- [nmnellis/vistio-api](https://hub.docker.com/r/nmnellis/vistio-api)
- [nmnellis/vistio-web](https://hub.docker.com/r/nmnellis/vistio-web)
## Deploy Vistio
### Deploy Vistio with Istio Ingress Gateway (kubectl)
* prometheusUrl - the default prometheus url is assumed to be based on the Istio deployment. If your Prometheus server is in a different namespace or has a different service name, you will need to edit the yaml files.
1. Deploy Istio
```sh
kubectl apply -f vistio-with-ingress.yaml -n default
```
2. Expose vistio-web
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-web -o jsonpath='{.items[0].metadata.name}') 8080:8080 &
```
3. Open Vistio
4. Expose vistio-api
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-api -o jsonpath='{.items[0].metadata.name}') 9091:9091 &
```
5. Test endpoint
6. Add traffic to the mesh by following bookinfo demo here [Istio Bookinfo Demo](https://istio.io/docs/guides/bookinfo/) and to get the `GATEWAY_URL` and calling
```sh
curl -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/productpage
```
### Deploy Vistio with Istio Ingress Gateway (helm)
* prometheusUrl - the default prometheus url is assumed to be based on the Istio deployment. If your Prometheus server is in a different namespace or has a different service name, you will need to edit the yaml files.
1. Deploy Vistio
```sh
helm install helm/vistio -f helm/vistio/values-with-ingress.yaml --name vistio --namespace default
```
2. Expose vistio-web
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-web -o jsonpath='{.items[0].metadata.name}') 8080:8080 &
```
3. Open Vistio
4. Expose vistio-api
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-api -o jsonpath='{.items[0].metadata.name}') 9091:9091 &
```
5. Test endpoint
6. Add traffic to the mesh by following bookinfo demo here [Istio Bookinfo Demo](https://istio.io/docs/guides/bookinfo/) and to get the `GATEWAY_URL` and calling
```sh
curl -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/productpage
```
### Deploy Vistio Without Istio Ingress (kubectl)
* prometheusUrl - the default prometheus url is assumed to be based on the Istio deployment. If your Prometheus server is in a different namespace or has a different service name, you will need to edit the yaml files.
1. Deploy Istio
```sh
kubectl apply -f vistio-mesh-only.yaml -n default
```
2. Expose vistio-web
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-web -o jsonpath='{.items[0].metadata.name}') 8080:8080 &
```
3. Open Vistio
4. Expose vistio-api
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-api -o jsonpath='{.items[0].metadata.name}') 9091:9091 &
```
5. Test endpoint
6. Add traffic to the mesh by following bookinfo demo here [Istio Bookinfo Demo](https://istio.io/docs/guides/bookinfo/) and to get the `GATEWAY_URL` and calling
```sh
curl -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/productpage
```
### Deploy Vistio Without Istio Ingress (Helm)
* prometheusUrl - the default prometheus url is assumed to be based on the Istio deployment. If your Prometheus server is in a different namespace or has a different service name, you will need to edit the yaml files.
1. Deploy Vistio
```sh
helm install helm/vistio -f helm/vistio/values-mesh-only.yaml --name vistio --namespace default
```
2. Expose vistio-web
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-web -o jsonpath='{.items[0].metadata.name}') 8080:8080 &
```
3. Open Vistio
4. Expose vistio-api
```sh
kubectl -n default port-forward $(kubectl -n default get pod -l app=vistio-api -o jsonpath='{.items[0].metadata.name}') 9091:9091 &
```
5. Test endpoint
6. Add traffic to the mesh by following bookinfo demo here [Istio Bookinfo Demo](https://istio.io/docs/guides/bookinfo/) and to get the `GATEWAY_URL` and calling
```sh
curl -o /dev/null -s -w "%{http_code}\n" http://${GATEWAY_URL}/productpage
```
## Configuration
See [configuration.md](https://github.com/nmnellis/vistio/blob/master/documentation/configuration.md) in documentation directory.
## docker-compose Example
An Istio example is in the `/example/docker` directory
You can try it by going to that directory and run
```
docker-compose up --build
```
Then checkout each service at:
- promviz-front: [http://localhost:8080/graph](http://localhost:8080/)
- vistio: [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)
## Troubleshooting
1. Blank Vistio home page - this typically means that the Prometheus query at the `global` level is not returning any data or the data is not matching the labels in the source or target configuration. Grab the globalLevel query and test it against Prometheus directly to verify the data is correct. Example global level query `sum(rate(istio_request_count[1m])) by (response_code)`
2. Cannot `Zoom` into clusters - If you are having trouble connecting your clusters to the global view, make sure the `target` values in the global configuration matches the cluster level name.
* Example global level target - in this example I rename all target values to istio-mesh
```yaml
globalLevel:
...
target:
replacement: istio-mesh
```
* Example clusterLevel configuration - the cluster name `istio-mesh` matches the target value at the global level
```yaml
clusterLevel:
- cluster: istio-mesh
```
## Releases
https://github.com/nmnellis/vistio/releases
* v0.1.0 - Initial Release
## Contributing
Please feel free to create an issue or pull request.
## LICENSE
Vistio is released under the MIT license. See LICENSE file for details.