audunsolemdal / aware

Aware - A highly visual system agnostic alerting dashboard

The purpose of this dashboard is to have it be more alarming and visual compared to e.g. the Prometheus Alerts page. You would typically set this dashboard up on a team-monitor and in the case of an event, get everyones attention, and then inspect further in another dashboard with more features.

Demo

When there are no events:

In the case of events and integrated with a log provider:
The background change color to the most severe event.

API Endpoints

The API exposes two endpoints (/api/events, and /api/exports).

/api/events GET

Returns a list of alerts sorted on time first triggered. Aggregated from all configured alerting API's. (Currently suppport Sensu Go-^5.17 and Prometheus ^2.15 )

/api/exports GET

Meant to be used when you have a protected network(Kubernetes cluster), where createing Auth mechanisms for the alerting backends are troublesome. You can then deploy Aware-API inside the LAN and have it gather events from the unprotected api's, and export them from this endpoint.

Returns the same list as from /api/events, but rewrites the "source" tag to the ENV_VAR DEPLOYMENT_NAME.

This endpoint is also protected with a very basic API-Key mechanism.

Authorization

GET /api/exports
Headers: AUTHORIZATION: Key MyVerySecretKey

Usage

The easiest way to test and/or use this dashboard is with Docker(-compose).
All configuration is loaded from environment variabled.

• DEPLOYMENT_NAME:
  Value that will be used as "source" on exported alerts
• PROMETHEUS_API
  The full URL to the Prometheus API to gather alerts from.
  (e.g. http://prometheus-operator-prometheus.monitoring:9090/api/v1/alerts; Here it points to a Kubernetes service in the 'monitoring' namespace.)
• SENSU_API:
  The full url to a Sensu Go api
• IMPORT_URLS:
  A string with several ";" separated URL's to import Aware-API standard alerts from.
• SENSU_KEY:
  The API-Key to the configured Sensu backend.
• EXPORT_SECRET:
  The key that clients will need to provide to Authenticate with the /api/exports endpoint.
• IGNORE_PROMETHEUS_ALERTS:
  A string with several ";" separated Prometheus AlertNames to be ignored.

Front end

Pretty simple stuff.
Changes background color based on "most sever alert".
Refetches all alerts every 30 seconds.

Limitations

• Only supports one of each Sensu and Prometheus backends.
• Only one export api-key.

aware's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update dependency styled-components to v6
• Update docker/build-push-action action to v5
• Update docker/login-action action to v3
• Update docker/metadata-action action to v5
• Update docker/setup-buildx-action action to v3
• Update github/codeql-action action to v3
• Update sigstore/cosign-installer action to v3
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency axios to v0.28.0 [SECURITY]
• Update dependency flask to v1.1.4
• Update react monorepo to v17.0.2 (react, react-dom)
• Update dependency requests to v2.32.3
• Update dependency styled-components to v5.3.11
• Update python Docker tag to v3.12
• Update sigstore/cosign-installer action to v2.8.1
• Update Node.js to v20
• Update actions/checkout action to v4
• Update dependency flask to v3
• Update react monorepo to v18 (major) (react, react-dom)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

docker-compose

docker-compose.yaml

dockerfile

api/Dockerfile

• python 3.8-slim

proxy/Dockerfile

runners/Dockerfile

web/Dockerfile

• node 12-alpine

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v2
• github/codeql-action v1
• github/codeql-action v1
• github/codeql-action v1

.github/workflows/docker-publish.yml

• actions/checkout v3
• docker/setup-buildx-action v2
• docker/login-action v2
• docker/metadata-action v4
• docker/build-push-action v3
• Azure/container-scan v0.1
• sigstore/cosign-installer v2.5.1

.github/workflows/docker-runner-publish.yaml

• actions/checkout v3
• docker/setup-buildx-action v2
• docker/login-action v2
• docker/metadata-action v4
• docker/build-push-action v3

npm

web/package.json

• axios 0.21.2
• react 17.0.1
• react-dom 17.0.1
• react-scripts 5.0.1
• styled-components 5.2.1

pep621

api/pyproject.toml

• poetry >=0.12

poetry

api/pyproject.toml

• python ^3.8
• flask ^1.1
• requests ^2.22

---

• Check this box to trigger a request for Renovate to run again on this repository