consul-topology-visualizer's Introduction

Consul Topology

This tool is made to vizualise latency between consul nodes based on the Coordinate API to compute the data.

Inspiration

Some people might recognize the similarity with Goldpinger which is indeed the tool that i used to kickstart my version, so big thanks you to them for open sourcing this tool in the first place.

The first difference is that i only wanted to vizualise things and didn't want to actually get alerted nor get metrics from this tools. But it's pretty trivial so someone need it, just ask and i might add it.

The second difference is that we don't actually need to deploy anything in your infrastructure since Consul compute pretty much all the data for us.

Configuration

As said earlier, you don't need to deploy anything along side your infrastructure, but there are still some configuration :

CONSUL_HTTP_ADDR: The address of the consul endpoint (can be either a master or client)
CONSUL_CACERT: The path (on the FS) to the Consul CA cert
CONSUL_CLIENT_CERT: The path (on the FS) to the client cert
CONSUL_CLIENT_KEY: The path (on the FS) to the client private key

Of course if you can access Consul in HTTP, you don't need to configure the certificate.

Note: It's the same environment variables as the CLI so it avoid you re-configured them on your laptop if you already have the CLI :)

Notes

I hacked this quickly during the holiday so it might not be the state of the art UX or code. Feel free to make a PR to implement the things that you want. I've built an image for deployment it into my production environment so if you want to re-use it: https://cloud.docker.com/repository/docker/vmarchaud/consul-topology

More screenshots

consul-topology-visualizer's People

Contributors

Stargazers

Watchers

consul-topology-visualizer's Issues

Golderpinger -> Goldpinger

Hey, someone pointed out to me that you misspelled the name of your inspiration :-)

Cool looking tool 👍

May I know how to start consul-topology-visualizer

Hi,

Thanks for sharing consul-topology-visualizer. But I have a little experience on web stuff, I really don't know how to use it. So can you please share the steps to start consul-topology-visualizer on Ubuntu?
BTW, I already set up a Consul cluster.

Docker image fails to start

I get this error:

⨯ Unable to compile TypeScript:
index.ts(29,14): error TS2580: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i @types/node` and then add `node` to the types field in your tsconfig.
index.ts(30,24): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the `lib` compiler option to include 'dom'.

Recommend Projects