django-nativemojo 0.1.10__py3-none-any.whl

mojo/apps/incident/handlers/event_handlers.py

@@ -0,0 +1,142 @@
+"""
+Event handlers for incident processing.
+
+This module contains handlers for processing incident events based on different
+handler types (task, email, notify). These handlers are used by the RuleSet.run_handler
+method to handle events that match rule criteria.
+"""
+
+class TaskHandler:
+    """
+    Handler for executing tasks based on events.
+    
+    This handler executes a named task with the given parameters
+    when an event matches rule criteria.
+    
+    Attributes:
+        handler_name (str): The name of the task to execute.
+        params (dict): Parameters to pass to the task.
+    """
+    
+    def __init__(self, handler_name, **params):
+        """
+        Initialize a TaskHandler with a task name and parameters.
+        
+        Args:
+            handler_name (str): The name of the task to execute.
+            **params: Parameters to pass to the task.
+        """
+        self.handler_name = handler_name
+        self.params = params
+        
+    def run(self, event):
+        """
+        Execute the task for the given event.
+        
+        Args:
+            event (Event): The event that triggered this handler.
+            
+        Returns:
+            bool: True if the task was executed successfully, False otherwise.
+        """
+        # TODO: Implement actual task execution logic
+        # For example, using Celery to execute tasks asynchronously
+        try:
+            # Example implementation:
+            # from mojo.tasks import execute_task
+            # result = execute_task.delay(self.handler_name, event=event, **self.params)
+            # return result.successful()
+            return True
+        except Exception as e:
+            # Log the error
+            # logger.error(f"Error executing task {self.handler_name}: {e}")
+            return False
+
+
+class EmailHandler:
+    """
+    Handler for sending email notifications based on events.
+    
+    This handler sends an email to the specified recipient
+    when an event matches rule criteria.
+    
+    Attributes:
+        recipient (str): The email address to send notifications to.
+    """
+    
+    def __init__(self, recipient):
+        """
+        Initialize an EmailHandler with a recipient.
+        
+        Args:
+            recipient (str): The email address to send notifications to.
+        """
+        self.recipient = recipient
+        
+    def run(self, event):
+        """
+        Send an email notification for the given event.
+        
+        Args:
+            event (Event): The event that triggered this handler.
+            
+        Returns:
+            bool: True if the email was sent successfully, False otherwise.
+        """
+        # TODO: Implement actual email sending logic
+        try:
+            # Example implementation:
+            # from mojo.helpers.mail import send_mail
+            # subject = f"Incident Alert: {event.name}"
+            # body = f"An incident has been detected:\n\n{event.details}\n\nMetadata: {event.metadata}"
+            # result = send_mail(subject, body, [self.recipient])
+            # return result
+            return True
+        except Exception as e:
+            # Log the error
+            # logger.error(f"Error sending email to {self.recipient}: {e}")
+            return False
+
+
+class NotifyHandler:
+    """
+    Handler for sending notifications through various channels based on events.
+    
+    This handler can send notifications through multiple channels (SMS, push, etc.)
+    when an event matches rule criteria.
+    
+    Attributes:
+        recipient (str): The recipient identifier (can be a username, user ID, etc.).
+    """
+    
+    def __init__(self, recipient):
+        """
+        Initialize a NotifyHandler with a recipient.
+        
+        Args:
+            recipient (str): The recipient identifier.
+        """
+        self.recipient = recipient
+        
+    def run(self, event):
+        """
+        Send a notification for the given event.
+        
+        Args:
+            event (Event): The event that triggered this handler.
+            
+        Returns:
+            bool: True if the notification was sent successfully, False otherwise.
+        """
+        # TODO: Implement actual notification logic
+        try:
+            # Example implementation:
+            # from mojo.helpers.notifications import send_notification
+            # message = f"Incident Alert: {event.name}\n{event.details}"
+            # result = send_notification(self.recipient, message, metadata=event.metadata)
+            # return result
+            return True
+        except Exception as e:
+            # Log the error
+            # logger.error(f"Error sending notification to {self.recipient}: {e}")
+            return False

mojo/apps/incident/migrations/0001_initial.py

@@ -0,0 +1,83 @@
+# Generated by Django 4.2.21 on 2025-06-04 02:22
+
+from django.db import migrations, models
+import django.db.models.deletion
+import mojo.models.rest
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Incident',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('priority', models.IntegerField(db_index=True, default=0)),
+                ('state', models.IntegerField(db_index=True, default=0)),
+                ('category', models.CharField(db_index=True, max_length=124)),
+                ('title', models.TextField(default=None, null=True)),
+                ('details', models.TextField(default=None, null=True)),
+                ('model_name', models.TextField(db_index=True, default=None, null=True)),
+                ('model_id', models.IntegerField(db_index=True, default=0)),
+                ('source_ip', models.CharField(blank=True, db_index=True, default=None, max_length=16, null=True)),
+                ('metadata', models.JSONField(blank=True, default=dict)),
+            ],
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+        migrations.CreateModel(
+            name='RuleSet',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('modified', models.DateTimeField(auto_now=True)),
+                ('priority', models.IntegerField(db_index=True, default=0)),
+                ('category', models.CharField(db_index=True, max_length=124)),
+                ('name', models.TextField(default=None, null=True)),
+                ('bundle', models.IntegerField(default=0)),
+                ('bundle_by', models.IntegerField(default=3)),
+                ('match_by', models.IntegerField(default=0)),
+                ('handler', models.TextField(default=None, null=True)),
+                ('metadata', models.JSONField(blank=True, default=dict)),
+            ],
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+        migrations.CreateModel(
+            name='Rule',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('modified', models.DateTimeField(auto_now=True)),
+                ('name', models.TextField(default=None, null=True)),
+                ('index', models.IntegerField(db_index=True, default=0)),
+                ('comparator', models.CharField(default='==', max_length=32)),
+                ('field_name', models.CharField(default=None, max_length=124, null=True)),
+                ('value', models.CharField(default='', max_length=124)),
+                ('value_type', models.CharField(default='int', max_length=10)),
+                ('is_required', models.IntegerField(default=0)),
+                ('parent', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='incident.ruleset')),
+            ],
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+        migrations.CreateModel(
+            name='Event',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('level', models.IntegerField(db_index=True, default=0)),
+                ('category', models.CharField(db_index=True, max_length=124)),
+                ('title', models.TextField(default=None, null=True)),
+                ('details', models.TextField(default=None, null=True)),
+                ('model_name', models.TextField(db_index=True, default=None, null=True)),
+                ('model_id', models.IntegerField(db_index=True, default=0)),
+                ('metadata', models.JSONField(blank=True, default=dict)),
+                ('incident', models.ForeignKey(default=None, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='events', to='incident.incident')),
+            ],
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+    ]

mojo/apps/incident/migrations/0002_rename_bundle_ruleset_bundle_minutes_event_hostname_and_more.py

@@ -0,0 +1,44 @@
+# Generated by Django 4.2.21 on 2025-06-04 13:42
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('incident', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='ruleset',
+            old_name='bundle',
+            new_name='bundle_minutes',
+        ),
+        migrations.AddField(
+            model_name='event',
+            name='hostname',
+            field=models.CharField(db_index=True, default=None, max_length=16, null=True),
+        ),
+        migrations.AddField(
+            model_name='event',
+            name='source_ip',
+            field=models.CharField(db_index=True, default=None, max_length=16, null=True),
+        ),
+        migrations.AddField(
+            model_name='incident',
+            name='hostname',
+            field=models.CharField(db_index=True, default=None, max_length=16, null=True),
+        ),
+        migrations.AddField(
+            model_name='incident',
+            name='rule_set',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='incidents', to='incident.ruleset'),
+        ),
+        migrations.AlterField(
+            model_name='incident',
+            name='source_ip',
+            field=models.CharField(db_index=True, default=None, max_length=16, null=True),
+        ),
+    ]

mojo/apps/incident/migrations/0003_alter_event_model_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.21 on 2025-06-04 14:30
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('incident', '0002_rename_bundle_ruleset_bundle_minutes_event_hostname_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='event',
+            name='model_id',
+            field=models.IntegerField(db_index=True, default=None, null=True),
+        ),
+    ]

mojo/apps/incident/migrations/0004_alter_incident_model_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.21 on 2025-06-04 17:22
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('incident', '0003_alter_event_model_id'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='incident',
+            name='model_id',
+            field=models.IntegerField(db_index=True, default=None, null=True),
+        ),
+    ]

mojo/apps/incident/models/__init__.py

@@ -0,0 +1,3 @@
+from .event import Event
+from .rule import RuleSet, Rule
+from .incident import Incident

mojo/apps/incident/models/event.py

@@ -0,0 +1,135 @@
+from mojo.apps.metrics import record
+from django.db import models
+from mojo.models import MojoModel
+from mojo.helpers import dates
+from mojo.helpers.settings import settings
+from mojo.apps import metrics
+
+
+INCIDENT_LEVEL_THRESHOLD = settings.get('INCIDENT_LEVEL_THRESHOLD', 7)
+
+class Event(models.Model, MojoModel):
+    """
+    Event model.
+
+    Level 0–3: Informational or low importance
+	Level 4–7: Warning or potential issue
+	Level 8–15: Increasing severity, with Level 15 being critical
+    """
+    created = models.DateTimeField(auto_now_add=True, editable=False, db_index=True)
+
+    level = models.IntegerField(default=0, db_index=True)
+    category = models.CharField(max_length=124, db_index=True)
+    source_ip = models.CharField(max_length=16, null=True, default=None, db_index=True)
+    hostname = models.CharField(max_length=16, null=True, default=None, db_index=True)
+
+    title = models.TextField(default=None, null=True)
+    details = models.TextField(default=None, null=True)
+
+    model_name = models.TextField(default=None, null=True, db_index=True)
+    model_id = models.IntegerField(default=None, null=True, db_index=True)
+
+    incident = models.ForeignKey("incident.Incident", null=True, related_name="events",
+        default=None, on_delete=models.CASCADE)
+
+    # JSON-based metadata field
+    metadata = models.JSONField(default=dict, blank=True)
+
+    class RestMeta:
+        SEARCH_FIELDS = ["details"]
+        VIEW_PERMS = ["view_incidents"]
+        CREATE_PERMS = None
+
+    def sync_metadata(self):
+        # Gather all field values into the metadata
+        field_values = {
+            'level': self.level,
+            'category': self.category,
+            'source_ip': self.source_ip,
+            'title': self.title,
+            'details': self.details,
+            'model_name': self.model_name,
+            'model_id': self.model_id        }
+        # Update the metadata with these values
+        self.metadata.update(field_values)
+
+    def publish(self):
+        from mojo.apps.incident.models import RuleSet
+        # Find the RuleSet by category
+        self.record_event_metrics()
+        rule_set = RuleSet.check_by_category(self.category, self)
+
+        if rule_set or self.level >= INCIDENT_LEVEL_THRESHOLD:
+            incident, created = self.get_or_create_incident(rule_set)
+            self.link_to_incident(incident)
+            if rule_set and created:
+                rule_set.run_handler(self, incident)
+
+    def record_event_metrics(self):
+        if settings.INCIDENT_EVENT_METRICS:
+            metrics.record('incident_events', account="incident",
+                min_granularity=settings.get("INCIDENT_METRICS_MIN_GRANULARITY", "hours"))
+
+    def record_incident_metrics(self):
+        if settings.INCIDENT_EVENT_METRICS:
+            metrics.record('incidents', account="incident",
+                min_granularity=settings.get("INCIDENT_METRICS_MIN_GRANULARITY", "hours"))
+
+    def get_or_create_incident(self, rule_set=None):
+        """
+        Gets or creates an incident based on the event's level and rule set bundle criteria.
+        """
+        from mojo.apps.incident.models import Incident
+
+        incident = None
+        created = False
+        if rule_set is not None and rule_set.bundle_by > 0:
+            bundle_criteria = self.determine_bundle_criteria(rule_set)
+            incident = Incident.objects.filter(**bundle_criteria).first()
+
+        if not incident:
+            # Create a new incident if none found
+            created = True
+            incident = Incident(
+                priority=self.level,
+                state=0,
+                category=self.category,
+                title=self.title,
+                details=self.details,
+                hostname=self.hostname,
+                model_name=self.model_name,
+                model_id=self.model_id,
+                source_ip=self.source_ip
+            )
+            incident.metadata.update(self.metadata)
+            incident.save()
+            self.record_incident_metrics()
+
+        return incident, created
+
+    def determine_bundle_criteria(self, rule_set):
+        """
+        Determines the bundle criteria based on the rule set configuration.
+        """
+        bundle_criteria = {
+            "category": self.category
+        }
+        if rule_set.bundle_minutes:
+            bundle_criteria['created__gte'] = dates.subtract(minutes=rule_set.bundle_minutes)
+        if rule_set.bundle_by in [1, 5, 6, 9]:  # hostname or hostname and others
+            bundle_criteria['hostname'] = self.hostname
+        if rule_set.bundle_by in [2, 3, 5, 6, 7, 8]:  # model and combinations
+            bundle_criteria['model_name'] = self.model_name
+            if rule_set.bundle_by in [3, 6, 8]:  # model_id where applicable
+                bundle_criteria['model_id'] = self.model_id
+        if rule_set.bundle_by in [4, 7, 8, 9]:  # source_ip and combinations
+            bundle_criteria['source_ip'] = self.source_ip
+
+        return bundle_criteria
+
+    def link_to_incident(self, incident):
+        """
+        Links the event to an incident and saves the event.
+        """
+        self.incident = incident
+        self.save()

mojo/apps/incident/models/incident.py

@@ -0,0 +1,33 @@
+from django.db import models
+from mojo.models import MojoModel
+
+
+class Incident(models.Model, MojoModel):
+    """
+    Incident model.
+    """
+    created = models.DateTimeField(auto_now_add=True, editable=False, db_index=True)
+
+    priority = models.IntegerField(default=0, db_index=True)
+    state = models.IntegerField(default=0, db_index=True)
+    category = models.CharField(max_length=124, db_index=True)
+    title = models.TextField(default=None, null=True)
+    details = models.TextField(default=None, null=True)
+
+    model_name = models.TextField(default=None, null=True, db_index=True)
+    model_id = models.IntegerField(default=None, null=True, db_index=True)
+
+    # the
+    source_ip = models.CharField(max_length=16, null=True, default=None, db_index=True)
+    hostname = models.CharField(max_length=16, null=True, default=None, db_index=True)
+
+    # JSON-based metadata field
+    metadata = models.JSONField(default=dict, blank=True)
+
+    rule_set = models.ForeignKey("incident.Ruleset", on_delete=models.SET_NULL,
+        null=True, blank=True, related_name="incidents")
+
+    class RestMeta:
+        SEARCH_FIELDS = ["details"]
+        VIEW_PERMS = ["view_incidents"]
+        CREATE_PERMS = None