Merge pull request #135 from GabrielSalla/create-example-monitors

Create example monitors

Author: GabrielSalla

README.md

@@ -16,7 +16,7 @@ A Sentinela Monitor is configured through 3 main parts, along some basic setting
 
 These implementations are enough for Sentinela to autonomously execute monitoring logic and automatically manages the issues.
 
-![sentinela example](./docs/images/example.gif)
+![sentinela example](/docs/images/example.gif)
 
 ## Example scenario: Pending orders with completed shipments
 Consider an online store where an order is expected to transition to `completed` as soon as its shipment is marked `completed`. Occasionally, inconsistencies arise: the shipment finishes but the order status remains stuck as `awaiting_delivery` or other intermediate state.
@@ -93,28 +93,29 @@ Sentinela provides a web dashboard, by default at port `8000`, with 2 sections:
 2. a monitor editor, where you can create and edit monitors directly from the browser
 
 **Overview**
-![dashboard overview](./docs/images/dashboard_overview.png)
+![dashboard overview](/docs/images/dashboard_overview.png)
 
 **Editor**
-![dashboard monitor editor](./docs/images/dashboard_editor.png)
+![dashboard monitor editor](/docs/images/dashboard_editor.png)
 
 # Documentation
-1. [Overview](./docs/overview.md)
-2. [Building a Monitor](./docs/monitor.md)
-    1. [Sample Monitor](./docs/sample_monitor.md)
-3. [Querying data from databases](./docs/querying.md)
-4. [Validating a monitor](./docs/monitor_validating.md)
-5. [Registering a monitor](./docs/monitor_registering.md)
+1. [Overview](/docs/overview.md)
+2. [Building a Monitor](/docs/monitor.md)
+    1. [Monitor lifecycle](/docs/monitor_lifecycle.md)
+    2. [Example Monitors](/docs/example_monitors.md)
+3. [Querying data from databases](/docs/querying.md)
+4. [Validating a monitor](/docs/monitor_validating.md)
+5. [Registering a monitor](/docs/monitor_registering.md)
 6. Deployment
-    1. [Configuration](./docs/configuration.md)
-    2. [Configuration file](./docs/configuration_file.md)
-    3. [How to run](./docs/how_to_run.md)
-7. [Monitoring Sentinela](./docs/monitoring_sentinela.md)
-8. [Plugins](./docs/plugins/plugins.md)
-    1. [AWS](./docs/plugins/aws.md)
-    2. [Postgres](./docs/plugins/postgres.md)
-    3. [Slack](./docs/plugins/slack.md)
+    1. [Configuration](/docs/configuration.md)
+    2. [Configuration file](/docs/configuration_file.md)
+    3. [How to run](/docs/how_to_run.md)
+7. [Monitoring Sentinela](/docs/monitoring_sentinela.md)
+8. [Plugins](/docs/plugins/plugins.md)
+    1. [AWS](/docs/plugins/aws.md)
+    2. [Postgres](/docs/plugins/postgres.md)
+    3. [Slack](/docs/plugins/slack.md)
 9. Interacting with Sentinela
-    1. [HTTP server](./docs/http_server.md)
+    1. [HTTP server](/docs/http_server.md)
 10. Special cases
-    1. [Dropping issues](./docs/dropping_issues.md)
+    1. [Dropping issues](/docs/dropping_issues.md)

configs/configs-scalable.yaml

@@ -4,8 +4,8 @@ plugins:
   - postgres
   - slack
 
-load_sample_monitors: true
-sample_monitors_path: sample_monitors
+load_example_monitors: true
+example_monitors_path: example_monitors
 internal_monitors_path: internal_monitors
 internal_monitors_notification:
   enabled: true

configs/configs.yaml

@@ -4,8 +4,8 @@ plugins:
   - postgres
   - slack
 
-load_sample_monitors: true
-sample_monitors_path: sample_monitors
+load_example_monitors: true
+example_monitors_path: example_monitors
 internal_monitors_path: internal_monitors
 internal_monitors_notification:
   enabled: true

docker/Dockerfile

@@ -12,7 +12,7 @@ COPY . /app/
 
 RUN python3 -m venv $VIRTUAL_ENV \
     && pip install --no-cache-dir --upgrade pip \
-    && pip install poetry --no-cache-dir \
+    && pip install --no-cache-dir poetry \
     && sh tools/install_dependencies.sh
 
 

docker/docker-compose-dev.yaml

@@ -29,8 +29,8 @@ services:
       - 8000:8000
     environment:
       CONFIGS_FILE: configs/configs.yaml
-      SAMPLE_SLACK_CHANNEL: C07NCL94SDT
-      SAMPLE_SLACK_MENTION: U07NFGGMB98
+      EXAMPLE_SLACK_CHANNEL: C07NCL94SDT
+      EXAMPLE_SLACK_MENTION: U07NFGGMB98
       SLACK_WEBSOCKET_ENABLED: true
       SLACK_MAIN_CHANNEL: C07NCL94SDT
       SLACK_MAIN_MENTION: U07NFGGMB98

docker/docker-compose-local.yaml

@@ -24,8 +24,8 @@ services:
       start_period: 2s
     environment:
       CONFIGS_FILE: configs/configs.yaml
-      SAMPLE_SLACK_CHANNEL: C07NCL94SDT
-      SAMPLE_SLACK_MENTION: U07NFGGMB98
+      EXAMPLE_SLACK_CHANNEL: C07NCL94SDT
+      EXAMPLE_SLACK_MENTION: U07NFGGMB98
       SLACK_WEBSOCKET_ENABLED: true
       SLACK_MAIN_CHANNEL: C07NCL94SDT
       SLACK_MAIN_MENTION: U07NFGGMB98

docker/docker-compose-scalable.yaml

@@ -35,8 +35,8 @@ services:
       start_period: 2s
     environment:
       CONFIGS_FILE: configs/configs-scalable.yaml
-      SAMPLE_SLACK_CHANNEL: C07NCL94SDT
-      SAMPLE_SLACK_MENTION: U07NFGGMB98
+      EXAMPLE_SLACK_CHANNEL: C07NCL94SDT
+      EXAMPLE_SLACK_MENTION: U07NFGGMB98
       SLACK_WEBSOCKET_ENABLED: true
       SLACK_MAIN_CHANNEL: C07NCL94SDT
       SLACK_MAIN_MENTION: U07NFGGMB98
@@ -68,8 +68,8 @@ services:
       start_period: 2s
     environment:
       CONFIGS_FILE: configs/configs-scalable.yaml
-      SAMPLE_SLACK_CHANNEL: C07NCL94SDT
-      SAMPLE_SLACK_MENTION: U07NFGGMB98
+      EXAMPLE_SLACK_CHANNEL: C07NCL94SDT
+      EXAMPLE_SLACK_MENTION: U07NFGGMB98
       SLACK_WEBSOCKET_ENABLED: true
       SLACK_MAIN_CHANNEL: C07NCL94SDT
       SLACK_MAIN_MENTION: U07NFGGMB98

docs/configuration.md

@@ -1,7 +1,7 @@
 # Configuration
-The basic configs are set through the `configs.yaml` file. This file is read when the application starts and all the settings will be loaded. The documentation found at [Configuration file](./configuration_file.md) provides an overview of the configuration parameters available.
+The basic configs are set through the `configs.yaml` file. This file is read when the application starts and all the settings will be loaded. The documentation found at [Configuration file](configuration_file.md) provides an overview of the configuration parameters available.
 
-The monitors path is also defined in the `configs.yaml` file. By default, it's set to the `sample_monitors` folder, but it can be changed to another folder if desired. The `configs.yaml` file also have other configurations that can be adjusted.
+The monitors path is also defined in the `configs.yaml` file. By default, it's set to the `example_monitors` folder, but it can be changed to another folder if desired. The `configs.yaml` file also have other configurations that can be adjusted.
 
 # Environment variables
 > [!IMPORTANT]

docs/configuration_file.md

@@ -5,8 +5,8 @@ This document provides an overview of the configuration parameters available in
 - `plugins`: List of strings. Plugins to be used by Sentinela. Check each plugin documentation to learn how to enable them.
 
 ## Monitors
-- `load_sample_monitors`: Boolean. Flag to enable the sample monitors.
-- `sample_monitors_path`: String. Path relative to the project root, where the sample monitors are stored.
+- `load_example_monitors`: Boolean. Flag to enable the example monitors.
+- `example_monitors_path`: String. Path relative to the project root, where the example monitors are stored.
 - `internal_monitors_path`: String. Path relative to the project root, where the internal monitors are stored.
 - `internal_monitors_notification`: Map. Settings for the notification to be sent by the internal monitors.
   - `enabled`: Boolean. Flag to enable the internal monitors notification.

docs/diagrams/diagrams.drawio

@@ -236,7 +236,7 @@
         <mxCell id="FxgzXEkrF_b3o0yHyvXR-78" style="edgeStyle=orthogonalEdgeStyle;rounded=0;sketch=1;hachureGap=4;jiggle=2;curveFitting=1;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;fontFamily=Architects Daughter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DArchitects%2BDaughter;" parent="1" source="FxgzXEkrF_b3o0yHyvXR-79" target="FxgzXEkrF_b3o0yHyvXR-81" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
-        <mxCell id="FxgzXEkrF_b3o0yHyvXR-79" value="If controller is enabled, register internal and sample monitors" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;curveFitting=1;jiggle=2;fontFamily=Architects Daughter;" parent="1" vertex="1">
+        <mxCell id="FxgzXEkrF_b3o0yHyvXR-79" value="If controller is enabled, register internal and example monitors" style="rounded=1;whiteSpace=wrap;html=1;fontSize=12;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;curveFitting=1;jiggle=2;fontFamily=Architects Daughter;" parent="1" vertex="1">
           <mxGeometry x="850" y="540" width="120" height="80" as="geometry" />
         </mxCell>
         <mxCell id="FxgzXEkrF_b3o0yHyvXR-80" style="edgeStyle=orthogonalEdgeStyle;rounded=0;sketch=1;hachureGap=4;jiggle=2;curveFitting=1;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;fontFamily=Architects Daughter;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DArchitects%2BDaughter;" parent="1" source="FxgzXEkrF_b3o0yHyvXR-81" target="FxgzXEkrF_b3o0yHyvXR-83" edge="1">