Merge pull request #100 from GabrielSalla/monitor-template

Create monitor template

Author: GabrielSalla

docs/monitor.md

@@ -1,5 +1,5 @@
 # Creating a new monitor
-This guide will walk through the steps to set up a new Monitor.
+This guide will walk through the steps to set up a new Monitor. The file [monitor_template.py](../resources/monitor_template.py) serves as a template for creating a new monitor. It includes all the necessary imports and settings to get started.
 
 As a demonstration, the Monitor that will be designed is intended to **search for users with invalid registration data**, specifically when their name is empty.
 
@@ -75,6 +75,13 @@ from monitor_utils import (
 )
 ```
 
+# The issue data type
+The `IssueDataType` class defines the structure of the data that represents an issue. It serves as a type annotation in the monitor's default functions, making development more intuitive and error-resistant while also providing a clear contract for the issue data structure.
+
+Define a class called `IssueDataType`, that inherits from `TypedDict`, and includes all the fields that will be present in the issue data for the monitor.
+
+**Attention**: The `IssueDataType` class must contain the field specified in the `model_id_key` parameter of the `IssueOptions` setting. This ensures that the issue’s unique identifier is consistently used across your monitor’s configuration. This setting will be presented in the [**Issue options**](#issue-options) section.
+
 # The settings
 To set up the monitor’s behavior, issues, and alerts, use the provided Options dataclasses. These settings define how the monitor will manage issues and alerts.
 
@@ -166,13 +173,6 @@ Priority levels definition. For the defined rule, what value should trigger each
 
 All priority levels defaults to `None`. If a level is set to `None`, it will not be triggered.
 
-# The issue data type
-The `IssueDataType` class defines the structure of the data that represents an issue. It serves as a type annotation in the monitor's default functions, making development more intuitive and error-resistant.
-
-Define a class called `IssueDataType`, that inherits from `TypedDict`, and includes all the fields that will be present in the issue data for the monitor.
-
-**Attention**: The `IssueDataType` class must contain the field specified in the `model_id_key` parameter of the `IssueOptions` setting. This ensures that the issue’s unique identifier is consistently used across your monitor’s configuration.
-
 ### Example
 For the user registration monitor, the issue data type should include the `id` and `name` fields, as these are the essential fields for identifying and tracking the issue.
 

internal_monitors/monitor_high_active_issues_count/monitor_high_active_issues_count.py

@@ -18,6 +18,13 @@
 
 TRIGGER_THRESHOLD = 500
 
+
+class IssueDataType(TypedDict):
+    monitor_id: int
+    monitor_name: str
+    active_issues_count: int
+
+
 monitor_options = MonitorOptions(
     update_cron="*/2 * * * *",
     search_cron="*/5 * * * *",
@@ -41,12 +48,6 @@
 )
 
 
-class IssueDataType(TypedDict):
-    monitor_id: int
-    monitor_name: str
-    active_issues_count: int
-
-
 async def search() -> list[IssueDataType] | None:
     sql = read_file("search_query.sql")
 

resources/monitor_template.py

@@ -0,0 +1,56 @@
+"""
+Monitor template
+Read the documentation to learn how to configure each field.
+"""
+
+from typing import TypedDict
+
+from monitor_utils import AlertOptions, CountRule, IssueOptions, MonitorOptions, PriorityLevels
+
+
+# Define the data structure of the issues
+class IssueDataType(TypedDict):
+    pass
+
+
+monitor_options = MonitorOptions(
+    search_cron="*/15 * * * *",
+    update_cron="*/5 * * * *",
+)
+
+# Define the behavior expected for the issues
+issue_options = IssueOptions(
+    model_id_key="id",
+    solvable=True,
+)
+
+# Define the alert triggering options
+alert_options = AlertOptions(
+    rule=CountRule(
+        priority_levels=PriorityLevels(
+            low=0,
+            moderate=1,
+            high=2,
+            critical=3,
+        )
+    )
+)
+
+
+async def search() -> list[IssueDataType] | None:
+    """Logic to search for the issues"""
+    pass
+
+
+async def update(issues_data: list[IssueDataType]) -> list[IssueDataType] | None:
+    """Logic to update the issues data"""
+    pass
+
+
+def is_solved(issue_data: IssueDataType) -> bool:
+    """Logic to determine if the issue is solved, based on its data"""
+    return True
+
+
+# Notification configurations
+notification_options = []

sample_monitors/test_monitor/test_monitor.py

@@ -4,6 +4,12 @@
 from monitor_utils import AlertOptions, CountRule, IssueOptions, MonitorOptions, PriorityLevels
 from notifications.internal_monitor_notification import internal_monitor_notification
 
+
+class IssueDataType(TypedDict):
+    id: int
+    value: int
+
+
 monitor_options = MonitorOptions(
     search_cron="* * * * *",
     update_cron="* * * * *",
@@ -26,11 +32,6 @@
 )
 
 
-class IssueDataType(TypedDict):
-    id: int
-    value: int
-
-
 async def search() -> list[IssueDataType] | None:
     # Return 5 issues data with a random 'id' and a random 'value' between 1
     # and 10

tests/sample_monitor_code.py

@@ -2,6 +2,13 @@
 
 from monitor_utils import IssueOptions, MonitorOptions
 
+
+class IssueDataType(TypedDict):
+    id: int
+    a: str
+    b: int
+
+
 monitor_options = MonitorOptions(
     search_cron="* * * * *",
     update_cron="* * * * *",
@@ -12,12 +19,6 @@
 )
 
 
-class IssueDataType(TypedDict):
-    id: int
-    a: str
-    b: int
-
-
 async def search() -> list[IssueDataType] | None: ...
 async def update(issues_data: list[IssueDataType]) -> list[IssueDataType] | None: ...
 def is_solved(issue_data: IssueDataType) -> bool: ...

tests/sample_monitors/internal/monitor_2/monitor_2.py

@@ -8,6 +8,12 @@
 configs.application_queue
 
 
+class IssueDataType(TypedDict):
+    id: str
+    a: str
+    b: int
+
+
 monitor_options = MonitorOptions(
     search_cron="* * * * *",
     update_cron="* * * * *",
@@ -18,12 +24,6 @@
 )
 
 
-class IssueDataType(TypedDict):
-    id: str
-    a: str
-    b: int
-
-
 async def search() -> list[IssueDataType] | None: ...
 
 

tests/sample_monitors/internal/monitor_3/monitor_3.py

@@ -3,6 +3,13 @@
 
 from monitor_utils import IssueOptions, MonitorOptions
 
+
+class IssueDataType(TypedDict):
+    id: str
+    a: str
+    b: int
+
+
 monitor_options = MonitorOptions(
     search_cron="* * * * *",
     update_cron="* * * * *",
@@ -13,12 +20,6 @@
 )
 
 
-class IssueDataType(TypedDict):
-    id: str
-    a: str
-    b: int
-
-
 async def search() -> list[IssueDataType] | None: ...
 
 

tests/sample_monitors/others/monitor_1/monitor_1.py

@@ -3,6 +3,13 @@
 
 from monitor_utils import IssueOptions, MonitorOptions
 
+
+class IssueDataType(TypedDict):
+    id: str
+    a: str
+    b: int
+
+
 monitor_options = MonitorOptions(
     search_cron="* * * * *",
     update_cron="* * * * *",
@@ -13,12 +20,6 @@
 )
 
 
-class IssueDataType(TypedDict):
-    id: str
-    a: str
-    b: int
-
-
 async def search() -> list[IssueDataType] | None: ...