File size: 7,217 Bytes
56b2689 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | """
Log retention service for managing run cleanup.
"""
import logging
from datetime import timedelta
from django.db.models import QuerySet
from django.utils import timezone
logger = logging.getLogger(__name__)
# Name for the auto-cleanup schedule in django-q2
CLEANUP_SCHEDULE_NAME = "pyrunner-auto-cleanup"
class RetentionService:
"""
Service for managing log retention and cleanup of old runs.
"""
@classmethod
def get_effective_retention(cls, script) -> tuple[int, int]:
"""
Get the effective retention settings for a script.
Per-script overrides take precedence over global settings.
Args:
script: Script model instance
Returns:
tuple: (retention_days, retention_count)
"""
from core.models import GlobalSettings
settings = GlobalSettings.get_settings()
# Use script override if set, otherwise use global
retention_days = (
script.retention_days_override
if script.retention_days_override is not None
else settings.retention_days
)
retention_count = (
script.retention_count_override
if script.retention_count_override is not None
else settings.retention_count
)
return retention_days, retention_count
@classmethod
def get_runs_to_delete_for_script(
cls, script, days: int | None = None, count: int | None = None
) -> QuerySet:
"""
Get queryset of runs that would be deleted for a specific script.
Args:
script: Script model instance
days: Override retention days (None = use effective setting)
count: Override retention count (None = use effective setting)
Returns:
QuerySet of Run objects to delete
"""
from core.models import Run
if days is None or count is None:
effective_days, effective_count = cls.get_effective_retention(script)
if days is None:
days = effective_days
if count is None:
count = effective_count
# Start with all runs for this script
runs = Run.objects.filter(script=script)
# Get IDs of runs to keep
runs_to_keep_ids = set()
# Keep runs newer than retention_days
if days > 0:
cutoff_date = timezone.now() - timedelta(days=days)
runs_to_keep_ids.update(
runs.filter(created_at__gte=cutoff_date).values_list("id", flat=True)
)
# Keep last N runs if count is set
if count > 0:
last_n_ids = runs.order_by("-created_at").values_list("id", flat=True)[
:count
]
runs_to_keep_ids.update(last_n_ids)
# If both are 0, keep everything (no cleanup)
if days == 0 and count == 0:
return Run.objects.none()
# Return runs NOT in the keep list
return runs.exclude(id__in=runs_to_keep_ids)
@classmethod
def cleanup_runs_for_script(
cls, script, days: int | None = None, count: int | None = None
) -> int:
"""
Delete old runs for a specific script based on retention policy.
Args:
script: Script model instance
days: Override retention days (None = use effective setting)
count: Override retention count (None = use effective setting)
Returns:
int: Number of runs deleted
"""
runs_to_delete = cls.get_runs_to_delete_for_script(script, days, count)
deleted_count, _ = runs_to_delete.delete()
if deleted_count > 0:
logger.info(
f"Deleted {deleted_count} runs for script '{script.name}' (id={script.id})"
)
return deleted_count
@classmethod
def cleanup_all_runs(cls) -> int:
"""
Run cleanup for all scripts using global/per-script settings.
Returns:
int: Total number of runs deleted
"""
from core.models import Script
total_deleted = 0
scripts = Script.objects.all()
for script in scripts:
try:
deleted = cls.cleanup_runs_for_script(script)
total_deleted += deleted
except Exception as e:
logger.error(
f"Failed to cleanup runs for script '{script.name}': {e}"
)
logger.info(f"Total cleanup: {total_deleted} runs deleted across all scripts")
return total_deleted
@classmethod
def get_cleanup_stats(cls) -> dict:
"""
Get statistics about what would be cleaned up.
Returns:
dict: Stats including total_runs, runs_to_delete, runs_to_keep, per_script breakdown
"""
from core.models import Script, Run
total_runs = Run.objects.count()
total_to_delete = 0
per_script = []
for script in Script.objects.all():
runs_count = script.runs.count()
to_delete_count = cls.get_runs_to_delete_for_script(script).count()
total_to_delete += to_delete_count
if runs_count > 0:
per_script.append({
"script_id": str(script.id),
"script_name": script.name,
"total_runs": runs_count,
"to_delete": to_delete_count,
"to_keep": runs_count - to_delete_count,
})
return {
"total_runs": total_runs,
"runs_to_delete": total_to_delete,
"runs_to_keep": total_runs - total_to_delete,
"per_script": per_script,
}
@classmethod
def enable_auto_cleanup(cls) -> None:
"""
Create django-q2 schedule for daily cleanup at 2 AM.
"""
from django_q.models import Schedule
from datetime import time
# Calculate next run at 2 AM
now = timezone.now()
next_run = now.replace(hour=2, minute=0, second=0, microsecond=0)
if next_run <= now:
next_run += timedelta(days=1)
Schedule.objects.update_or_create(
name=CLEANUP_SCHEDULE_NAME,
defaults={
"func": "core.tasks.cleanup_old_runs_task",
"schedule_type": Schedule.DAILY,
"next_run": next_run,
"repeats": -1, # Repeat forever
},
)
logger.info(f"Auto-cleanup schedule enabled, next run at {next_run}")
@classmethod
def disable_auto_cleanup(cls) -> None:
"""
Remove auto-cleanup schedule.
"""
from django_q.models import Schedule
deleted, _ = Schedule.objects.filter(name=CLEANUP_SCHEDULE_NAME).delete()
if deleted:
logger.info("Auto-cleanup schedule disabled")
@classmethod
def is_auto_cleanup_scheduled(cls) -> bool:
"""
Check if auto-cleanup is currently scheduled.
"""
from django_q.models import Schedule
return Schedule.objects.filter(name=CLEANUP_SCHEDULE_NAME).exists()
|