Delete logs periodicaly

[maghasemzadeh]

Handling views with too many calls is hard. There exists no procedure to delete records periodically. This would be a very useful feature to delete records of logs periodically.

Solution:
we could have a variable called delete_log_days_period in LoggingMixin that is None by default. If the programmer wants to delete that view API log reports that are for before delete_log_days_period days before now, he set this variable to an integer. then records are deleted periodically.

[nickmccullum]

You can set up a Celery task to do this. It would look something like this (for a 30-day log retention period):

def delete_stale_logs(self) -> None:
    APIRequestLog.objects.filter(requested_at__lte=datetime.datetime.now()-datetime.timedelta(days=30)).delete()

[neilhut42]

You could use a custom management command

from datetime import timedelta

from django.core.management.base import BaseCommand, CommandError
from django.utils import timezone
from django.conf import settings

if 'rest_framework_tracking' in settings.INSTALLED_APPS:
    from rest_framework_tracking.models import APIRequestLog


class Command(BaseCommand):
    help = 'Cleans up APIRequest logs'

    def add_arguments(self, parser):

        parser.add_argument('-o', '--older', type=int, help='Hours for log retention', )

    def handle(self, *args, **options):

        # this of course should only work if
        # rest_framework_tracking is installed
        if 'rest_framework_tracking' not in settings.INSTALLED_APPS:
            raise CommandError(
                'rest_framework_tracking is not installed '
                'or configured in INSTALLED_APPS'
            )

        older = options.get('older')
        if older:
            threshold = older
        else:
            threshold = settings.APIREQUESTLOG_RETENTION_HOURS

        time_threshold = (
            timezone.now() -
            timedelta(hours=threshold)
        )

        deleted, obj = (
            APIRequestLog.objects.filter(
                requested_at__lt=time_threshold
            ).delete()
        )

        self.stdout.write(
            self.style.SUCCESS(f'Cleaned {deleted} APIRequestLog entries')
        )