Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Nitro/envoy-ui

Dead simple server-side UI for Envoy proxy (like HAproxy stats)
https://github.com/Nitro/envoy-ui

Last synced: 3 months ago
JSON representation

Dead simple server-side UI for Envoy proxy (like HAproxy stats)

Host: GitHub
URL: https://github.com/Nitro/envoy-ui
Owner: Nitro
License: mit
Created: 2017-12-07T14:40:21.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2022-02-23T11:35:20.000Z (over 2 years ago)
Last Synced: 2024-04-16T23:49:14.852Z (7 months ago)
Language: Crystal
Size: 187 KB
Stars: 75
Watchers: 5
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-repositories - Nitro/envoy-ui - Dead simple server-side UI for Envoy proxy (like HAproxy stats) (Crystal)

README

Envoy UI
========

A simple UI for the CNCF's [Envoy proxy](https://www.envoyproxy.io/) that
replicates some of the functionality of the HAproxy stats page. Intended to
talk to a single instance of the proxy.

Fetches statistics from `/clusters` and `/stats` on the Envoy node and renders
a single page with a more human-readable view of the statistics. Best used for
instances that are gateway nodes or Internet-facing headends. Each view is a
snapshot in time and does not auto-update.

Sample dashboard page for a proxy instance:
![Envoy UI](assets/envoy-ui.png)

Installation
------------

You may either use the pre-built [Docker
image](https://hub.docker.com/r/gonitro/envoy-ui/) or build the binaries
yourself natively with [Crystal](https://crystal-lang.org). It has been
tested on Linux and macOS.

```
$ crystal build --release envoy-ui.cr
$ ./envoy-ui
```

To build an image locally and run a container
```
$ docker build -t envoy-ui .
$ docker run envoy-ui
```

Configuration
-------------

If you are running Envoy UI on the command line you can configure it with
CLI flags:
```
$ ./envoy-ui --help
Usage: envoy-ui [arguments]
-h HOSTNAME, --host=HOSTNAME Envoy proxy hostname (127.0.0.1)
-p PORT, --port=PORT Envoy proxy port (9901)
-l PORT, --listen-port=PORT Port to listen on (8080)
--help Show this help
```

If you are running it in the Docker container, you may configure it with
environment variables:

* `ENVOY_UI_HOST`: Envoy proxy hostname
* `ENVOY_UI_PORT`: Envoy proxy port
* `ENVOY_UI_LISTEN_PORT`: Port to listen on

Contributing
------------

Contributions are more than welcome. Bug reports with specific reproduction
steps are great. If you have a code contribution you'd like to make, open a
pull request with suggested code.

Pull requests should:

* Clearly state their intent in the title
* Have a description that explains the need for the changes
* Include tests!
* Not break the public API

Ping us to let us know you're working on it by opening a GitHub Issue on the
project.