Merge pull request #130 from GabrielSalla/create-dashboard

Create dashboard

Author: GabrielSalla

README.md

@@ -90,6 +90,17 @@ Common use cases:
 
 State machine-related issues often require several data checks and conditional logic to identify. These issues are typically difficult to capture using standard logs and metrics but can be easily addressed using Sentinela Monitoring.
 
+# Dashboard
+Sentinela provides a web dashboard with 2 sections:
+1. an overview of the monitors and their alerts and issues
+2. a monitor editor, where you can create and edit monitors directly from the browser
+
+**Overview**
+![dashboard overview](./docs/images/dashboard_overview.png)
+
+**Editor**
+![dashboard monitor editor](./docs/images/dashboard_editor.png)
+
 # Documentation
 1. [Overview](./docs/overview.md)
 2. [Building a Monitor](./docs/monitor.md)

configs/configs-scalable.yaml

@@ -34,6 +34,7 @@ application_queue:
 http_server:
   port: 8000
   log_level: error
+  dashboard_enabled: true
 
 time_zone: America/Sao_Paulo
 

configs/configs.yaml

@@ -29,6 +29,7 @@ application_queue:
 http_server:
   port: 8000
   log_level: error
+  dashboard_enabled: true
 
 time_zone: America/Sao_Paulo
 

docs/configuration_file.md

@@ -57,7 +57,10 @@ application_queue:
 ```
 
 ## HTTP Server
-- `http_server.port`: Integer. Port for the HTTP server.
+- `http_server`:
+  - `port`: Integer. Port for the HTTP server.
+  - `log_level`: String. Log level for the HTTP server. Can be `default`, `warning`, `error` or `none`. Defaults to `default`.
+  - `dashboard_enabled`: Boolean. Flag to enable the Sentinela dashboard. Defaults to `false`.
 
 ## Time Zone
 - `time_zone`: String. Time zone to use for cron scheduling and notification messages.

docs/http_server.md

@@ -1,7 +1,7 @@
 # HTTP server
 The HTTP server provides an API to interact with Sentinela. The available routes are organized into two main categories, based on the deployment setup.
 
-If the container is deployed with the **Controller** (either standalone or alongside the Executor in the same container), all routes are available, allowing interactions with Monitors, Issues, and Alerts.
+If the container is deployed with the **Controller** (either standalone or alongside the Executor in the same container), all routes are available, allowing interactions with Monitors, Issues, Alerts and the dashboard.
 
 If the container is deployed with only the **Executor**, only base routes are available.
 
@@ -23,6 +23,11 @@ Exposes Prometheus-formatted metrics, enabling external monitoring and observabi
 # Interaction routes
 These routes are available only when the container deployment includes the **Controller** component.
 
+## Dashboard
+**`/dashboard`**
+
+Serves a simple dashboard interface, providing a quick way to create, enable or disable and change the monitors code.
+
 ## List monitors
 **`GET /monitors/list`**
 

docs/images/dashboard_editor.png

@@ -40,6 +40,7 @@ data:
     http_server:
       port: 8000
       log_level: error
+      dashboard_enabled: true
 
     time_zone: America/Sao_Paulo