Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions configs/configs-scalable.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ application_queue:
http_server:
port: 8000
log_level: error
dashboard_enabled: true

time_zone: America/Sao_Paulo

Expand Down
1 change: 1 addition & 0 deletions configs/configs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ application_queue:
http_server:
port: 8000
log_level: error
dashboard_enabled: true

time_zone: America/Sao_Paulo

Expand Down
5 changes: 4 additions & 1 deletion docs/configuration_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 6 additions & 1 deletion docs/http_server.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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`**

Expand Down
Binary file added docs/images/dashboard_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/dashboard_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions resources/kubernetes_template/config_map.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ data:
http_server:
port: 8000
log_level: error
dashboard_enabled: true

time_zone: America/Sao_Paulo

Expand Down
Loading