https://github.com/apocas/prometheus-canvas

Realtime turnkey Prometheus canvas based status page / dashboard
https://github.com/apocas/prometheus-canvas

canvas dashboard nodejs prometheus status

Last synced: 6 days ago
JSON representation

Realtime turnkey Prometheus canvas based status page / dashboard

• Host: GitHub
• URL: https://github.com/apocas/prometheus-canvas
• Owner: apocas
• License: apache-2.0
• Created: 2021-05-11T00:30:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-11T09:56:24.000Z (over 3 years ago)
• Last Synced: 2024-12-22T03:41:58.249Z (27 days ago)
• Topics: canvas, dashboard, nodejs, prometheus, status
• Language: JavaScript
• Homepage:
• Size: 80.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# prometheus-canvas

Realtime turnkey canvas status page for [Prometheus](https://prometheus.io)

* Each server is represented by a dot. Green, yellow or red depending on the server's health thresholds.

* Dots close to each other will connect.

* Collision avoidance is random'ish.

* Servers names are anonymized/hashed, built to be public.

## Demo

[https://live.ptisp.pt](https://live.ptisp.pt)

## Installation

`git clone https://github.com/apocas/prometheus-canvas`

`npm install`

`PROMETHEUS=http://127.0.0.1:9090 npm start`

## Env Vars

- **PROMETHEUS** - Prometheus URL, using default queries. Example: http://127.0.0.1:9090

- **SERVERS_QUERY** - If `PROMETHEUS` env var isn't used, full servers list query. Example: http://127.0.0.1:9090/api/v1/query?query=count(node_exporter_build_info)%20by%20(instance)

- **ALERTS_QUERY** - If `PROMETHEUS` env var isn't used, alert count query. Example: http://127.0.0.1:9090/api/v1/query?query=count(ALERTS{alertstate=%22firing%22})%20by(instance)

- **LOGO** - Background logo URL. Example: http://127.0.0.1/logo.png

- **RED_THRESHOLD** - Number of alerts for a server to be considered red. Default: 4

- **YELLOW_THRESHOLD** - Number of alerts for a server to be considered yellow. Default: 2

- **PORT** - Listening port. Default: 80

- **INTERVAL** - Data refresh interval in seconds. Default: 60

- **SIZE** - Dots size multiplier. Default: 1

## License

Pedro Dias - [@pedromdias](https://twitter.com/pedromdias)

Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:

    http://www.apache.org/licenses/LICENSE-2.0.html

Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.