[feature] Add way to specify global defaults #106

Implements and closes #106

Author: nepython

README.rst

@@ -1,7 +1,6 @@
 from swapper import load_model
 
 from ...device.utils import SHORT_RP
-from ..settings import CONFIG_CHECK_MAX_TIME
 from .base import BaseCheck
 
 AlertSettings = load_model('monitoring', 'AlertSettings')
@@ -28,8 +27,6 @@ def _get_metric(self):
         return metric
 
     def _create_alert_setting(self, metric):
-        alert_s = AlertSettings(
-            metric=metric, operator='<', value=1, seconds=CONFIG_CHECK_MAX_TIME * 60
-        )
+        alert_s = AlertSettings(metric=metric)
         alert_s.full_clean()
         alert_s.save()

openwisp_monitoring/check/classes/config_applied.py

@@ -154,7 +154,7 @@ def _get_metric(self):
         return metric
 
     def _create_alert_settings(self, metric):
-        alert_settings = AlertSettings(metric=metric, operator='<', value=1, seconds=0)
+        alert_settings = AlertSettings(metric=metric)
         alert_settings.full_clean()
         alert_settings.save()
 

openwisp_monitoring/check/classes/ping.py

@@ -12,8 +12,4 @@
 AUTO_CONFIG_CHECK = getattr(
     settings, 'OPENWISP_MONITORING_AUTO_DEVICE_CONFIG_CHECK', True
 )
-# Input in minutes
-CONFIG_CHECK_MAX_TIME = getattr(
-    settings, 'OPENWISP_MONITORING_DEVICE_CONFIG_CHECK_MAX_TIME', 5
-)
 MANAGEMENT_IP_ONLY = getattr(settings, 'OPENWISP_MONITORING_MANAGEMENT_IP_ONLY', True)

openwisp_monitoring/check/settings.py

@@ -226,7 +226,9 @@ def test_read_with_rp(self):
             'Test metric write on short retention_policy immediate alert'
         ):
             m = self._create_general_metric(name='dummy')
-            self._create_alert_settings(metric=m, operator='<', value=1, seconds=0)
+            self._create_alert_settings(
+                metric=m, custom_operator='<', custom_threshold=1, custom_tolerance=0
+            )
             m.write(0, retention_policy=SHORT_RP)
             self.assertEqual(m.read(retention_policy=SHORT_RP)[0][m.field_name], 0)
             self.assertFalse(m.is_healthy)
@@ -235,7 +237,9 @@ def test_read_with_rp(self):
             'Test metric write on short retention_policy with deferred alert'
         ):
             m2 = self._create_general_metric(name='dummy2')
-            self._create_alert_settings(metric=m2, operator='<', value=1, seconds=60)
+            self._create_alert_settings(
+                metric=m2, custom_operator='<', custom_threshold=1, custom_tolerance=1
+            )
             m.write(0, retention_policy=SHORT_RP, time=now() - timedelta(minutes=2))
             self.assertEqual(m.read(retention_policy=SHORT_RP)[0][m.field_name], 0)
             self.assertFalse(m.is_healthy)

openwisp_monitoring/db/backends/influxdb/tests.py

@@ -4,6 +4,7 @@
 from django.contrib.contenttypes.admin import GenericStackedInline
 from django.contrib.contenttypes.forms import BaseGenericInlineFormSet
 from django.contrib.contenttypes.models import ContentType
+from django.forms import ModelForm
 from django.urls import reverse
 from django.utils.html import format_html
 from django.utils.safestring import mark_safe
@@ -58,11 +59,24 @@ def has_delete_permission(self, request, obj=None):
         return False
 
 
+class AlertSettingsForm(ModelForm):
+    def __init__(self, *args, **kwargs):
+        instance = kwargs.get('instance')
+        if instance:
+            kwargs['initial'] = {
+                'custom_tolerance': instance.tolerance,
+                'custom_operator': instance.operator,
+                'custom_threshold': instance.threshold,
+            }
+        super().__init__(*args, **kwargs)
+
+
 class AlertSettingsInline(NestedStackedInline):
     model = AlertSettings
     extra = 0
     max_num = 0
     exclude = ['created', 'modified']
+    form = AlertSettingsForm
 
     def get_queryset(self, request):
         return super().get_queryset(request).order_by('created')

openwisp_monitoring/device/admin.py

@@ -20,7 +20,6 @@
 from ... import settings as monitoring_settings
 from ...monitoring.exceptions import InvalidChartConfigException
 from ..schema import schema
-from ..settings import DEVICE_RESOURCES_ALERTSETTINGS
 from ..signals import device_metrics_received
 
 logger = logging.getLogger(__name__)
@@ -352,10 +351,7 @@ def _create_resources_chart(self, metric, resource):
         chart.save()
 
     def _create_resources_alert_settings(self, metric, resource):
-        value = DEVICE_RESOURCES_ALERTSETTINGS[resource]
-        alert_settings = AlertSettings(
-            metric=metric, operator='>', value=value, seconds=0
-        )
+        alert_settings = AlertSettings(metric=metric)
         alert_settings.full_clean()
         alert_settings.save()
 

openwisp_monitoring/device/api/views.py

@@ -151,7 +151,7 @@ def register_notifcation_types(self):
         register_notification_type(
             'connection_is_working',
             {
-                'name': 'Device Alert',
+                'verbose_name': 'Device Alert',
                 'verb': 'working',
                 'level': 'info',
                 'email_subject': '[{site.name}] RECOVERY: Connection to device {notification.target}',
@@ -165,7 +165,7 @@ def register_notifcation_types(self):
         register_notification_type(
             'connection_is_not_working',
             {
-                'name': 'Device Alert',
+                'verbose_name': 'Device Alert',
                 'verb': 'not working',
                 'level': 'error',
                 'email_subject': '[{site.name}] PROBLEM: Connection to device {notification.target}',

openwisp_monitoring/device/apps.py

@@ -58,9 +58,3 @@ def get_health_status_labels():
 MAC_VENDOR_DETECTION = getattr(
     settings, 'OPENWISP_MONITORING_MAC_VENDOR_DETECTION', True
 )
-
-DEVICE_RESOURCES_ALERTSETTINGS = getattr(
-    settings,
-    'OPENWISP_MONITORING_DEVICE_RESOURCES_ALERTSETTINGS',
-    {'memory': 0.95, 'cpu': 0.90, 'disk': 0.80},
-)

openwisp_monitoring/device/settings.py

@@ -493,14 +493,21 @@ def _create_env(self):
         ping = self._create_object_metric(
             name='ping', key='ping', field_name='reachable', content_object=d
         )
-        self._create_alert_settings(metric=ping, operator='<', value=1, seconds=0)
+        self._create_alert_settings(
+            metric=ping, custom_operator='<', custom_threshold=1, custom_tolerance=0
+        )
         load = self._create_object_metric(name='load', content_object=d)
-        self._create_alert_settings(metric=load, operator='>', value=90, seconds=0)
+        self._create_alert_settings(
+            metric=load, custom_operator='>', custom_threshold=90, custom_tolerance=0
+        )
         process_count = self._create_object_metric(
             name='process_count', content_object=d
         )
         self._create_alert_settings(
-            metric=process_count, operator='>', value=20, seconds=0
+            metric=process_count,
+            custom_operator='>',
+            custom_threshold=20,
+            custom_tolerance=0,
         )
         return dm, ping, load, process_count
 

openwisp_monitoring/device/tests/test_models.py

@@ -1,4 +1,5 @@
 from django.contrib import admin
+from django.forms import ModelForm
 from django.utils.translation import gettext_lazy as _
 from swapper import load_model
 
@@ -9,8 +10,21 @@
 AlertSettings = load_model('monitoring', 'AlertSettings')
 
 
+class AlertSettingsForm(ModelForm):
+    def __init__(self, *args, **kwargs):
+        instance = kwargs.get('instance')
+        if instance:
+            kwargs['initial'] = {
+                'custom_tolerance': instance.tolerance,
+                'custom_threshold': instance.threshold,
+                'custom_operator': instance.operator,
+            }
+        super().__init__(*args, **kwargs)
+
+
 class AlertSettingsInline(TimeReadonlyAdminMixin, admin.StackedInline):
     model = AlertSettings
+    form = AlertSettingsForm
     extra = 0
 
 

openwisp_monitoring/monitoring/admin.py

@@ -3,10 +3,10 @@
 from django.apps import AppConfig
 from django.conf import settings
 from django.utils.translation import gettext_lazy as _
-from openwisp_notifications.types import register_notification_type
 from requests.exceptions import ConnectionError
 
 from ..db import timeseries_db
+from .configuration import get_metric_configuration, register_metric_notifications
 
 
 class MonitoringConfig(AppConfig):
@@ -19,7 +19,9 @@ class MonitoringConfig(AppConfig):
     def ready(self):
         self.create_database()
         setattr(settings, 'OPENWISP_ADMIN_SHOW_USERLINKS_BLOCK', True)
-        self.register_notification_types()
+        metrics = get_metric_configuration()
+        for metric_name, metric_config in metrics.items():
+            register_metric_notifications(metric_name, metric_config)
 
     def create_database(self):
         # create Timeseries database if it doesn't exist yet
@@ -38,31 +40,3 @@ def warn_and_delay(self, attempt_number):
             f'Retrying again in 3 seconds (attempt n. {attempt_number} out of 5).'
         )
         sleep(self.retry_delay)
-
-    def register_notification_types(self):
-        default_message = (
-            '{notification.actor.name} for device [{notification.target}]'
-            '({notification.target_link}) {notification.verb}.'
-        )
-
-        register_notification_type(
-            'threshold_crossed',
-            {
-                'name': 'Monitoring Alert',
-                'verb': 'crossed the threshold',
-                'level': 'warning',
-                'email_subject': '[{site.name}] PROBLEM: {notification.actor.name} {notification.target}',
-                'message': default_message,
-            },
-        )
-
-        register_notification_type(
-            'threshold_recovery',
-            {
-                'name': 'Monitoring Alert',
-                'verb': 'returned within the threshold',
-                'level': 'info',
-                'email_subject': '[{site.name}] RECOVERY: {notification.actor.name} {notification.target}',
-                'message': default_message,
-            },
-        )