Closes #6590: Introduce a nightly housekeeping command to clear expired sessions and change records

netbox/extras/management/commands/housekeeping.py

@@ -0,0 +1,51 @@
+from datetime import timedelta
+from importlib import import_module
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+from django.db import DEFAULT_DB_ALIAS
+from django.utils import timezone
+
+from extras.models import ObjectChange
+
+
+class Command(BaseCommand):
+    help = "Perform nightly housekeeping tasks. (This command can be run at any time.)"
+
+    def handle(self, *args, **options):
+
+        # Clear expired authentication sessions (essentially replicating the `clearsessions` command)
+        self.stdout.write("[*] Clearing expired authentication sessions")
+        if options['verbosity'] >= 2:
+            self.stdout.write(f"\tConfigured session engine: {settings.SESSION_ENGINE}")
+        engine = import_module(settings.SESSION_ENGINE)
+        try:
+            engine.SessionStore.clear_expired()
+            self.stdout.write("\tSessions cleared.", self.style.SUCCESS)
+        except NotImplementedError:
+            self.stdout.write(
+                f"\tThe configured session engine ({settings.SESSION_ENGINE}) does not support "
+                f"clearing sessions; skipping."
+            )
+
+        # Delete expired ObjectRecords
+        self.stdout.write("[*] Checking for expired changelog records")
+        if settings.CHANGELOG_RETENTION:
+            cutoff = timezone.now() - timedelta(days=settings.CHANGELOG_RETENTION)
+            if options['verbosity'] >= 2:
+                self.stdout.write(f"Retention period: {settings.CHANGELOG_RETENTION} days")
+                self.stdout.write(f"\tCut-off time: {cutoff}")
+            expired_records = ObjectChange.objects.filter(time__lt=cutoff).count()
+            if expired_records:
+                self.stdout.write(f"\tDeleting {expired_records} expired records... ", self.style.WARNING, ending="")
+                self.stdout.flush()
+                ObjectChange.objects.filter(time__lt=cutoff)._raw_delete(using=DEFAULT_DB_ALIAS)
+                self.stdout.write("Done.", self.style.WARNING)
+            else:
+                self.stdout.write("\tNo expired records found.")
+        else:
+            self.stdout.write(
+                f"\tSkipping: No retention period specified (CHANGELOG_RETENTION = {settings.CHANGELOG_RETENTION})"
+            )
+
+        self.stdout.write("Finished.", self.style.SUCCESS)

netbox/extras/signals.py

@@ -1,13 +1,8 @@
-import random
-from datetime import timedelta
-
 from cacheops.signals import cache_invalidated, cache_read
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
-from django.db import DEFAULT_DB_ALIAS
 from django.db.models.signals import m2m_changed, post_save, pre_delete
 from django.dispatch import receiver
-from django.utils import timezone
 from django_prometheus.models import model_deletes, model_inserts, model_updates
 from prometheus_client import Counter
 
@@ -79,11 +74,6 @@ def _handle_changed_object(request, webhook_queue, sender, instance, **kwargs):
     elif action == ObjectChangeActionChoices.ACTION_UPDATE:
         model_updates.labels(instance._meta.model_name).inc()
 
-    # Housekeeping: 0.1% chance of clearing out expired ObjectChanges
-    if settings.CHANGELOG_RETENTION and random.randint(1, 1000) == 1:
-        cutoff = timezone.now() - timedelta(days=settings.CHANGELOG_RETENTION)
-        ObjectChange.objects.filter(time__lt=cutoff)._raw_delete(using=DEFAULT_DB_ALIAS)
-
 
 def _handle_deleted_object(request, webhook_queue, sender, instance, **kwargs):
     """