Move syslog cleanup from daily to a scheduled job (librenms#18258)

* Move syslog cleanup from daily to a scheduled job

* Apply fixes from StyleCI

Author: Jellyfrog

app/Console/Commands/MaintenanceSyslogCleanup.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Console\LnmsCommand;
+use App\Facades\LibrenmsConfig;
+use App\Models\Syslog;
+use Carbon\Carbon;
+use Illuminate\Support\Facades\Cache;
+
+class MaintenanceSyslogCleanup extends LnmsCommand
+{
+    protected $name = 'maintenance:syslog-cleanup';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(): int
+    {
+        $lock = Cache::lock('syslog_purge', 86000);
+        if (! $lock->get()) {
+            return 1;
+        }
+
+        $syslog_purge = LibrenmsConfig::get('syslog_purge');
+        if (! is_numeric($syslog_purge)) {
+            return 0;
+        }
+
+        $deleted_total = 0;
+        $deleted_rows = 1;
+        while ($deleted_rows > 0) {
+            $deleted_rows = Syslog::where('timestamp', '<=', Carbon::now()->subDays($syslog_purge)->toDateTimeString())
+                            ->limit(5000)
+                            ->delete();
+            $deleted_total += $deleted_rows;
+        }
+        $lock->release();
+
+        $this->line(trans('commands.maintenance:syslog-cleanup.delete', ['days' => $syslog_purge, 'count' => $deleted_total]));
+
+        return 0;
+    }
+}

daily.php

@@ -78,36 +78,6 @@
     }
 }
 
-if ($options['f'] === 'syslog') {
-    $lock = Cache::lock('syslog_purge', 86000);
-    if ($lock->get()) {
-        $syslog_purge = LibrenmsConfig::get('syslog_purge');
-
-        if (is_numeric($syslog_purge)) {
-            $rows = (int) dbFetchCell('SELECT MIN(seq) FROM syslog');
-            $initial_rows = $rows;
-            while (true) {
-                $limit = dbFetchCell('SELECT seq FROM syslog WHERE seq >= ? ORDER BY seq LIMIT 1000,1', [$rows]);
-                if (empty($limit)) {
-                    break;
-                }
-
-                // Deletes are done in blocks of 1000 to avoid a single very large operation.
-                if (dbDelete('syslog', 'seq >= ? AND seq < ? AND timestamp < DATE_SUB(NOW(), INTERVAL ? DAY)', [$rows, $limit, $syslog_purge]) > 0) {
-                    $rows = $limit;
-                } else {
-                    break;
-                }
-            }
-
-            dbDelete('syslog', 'seq >= ? AND timestamp < DATE_SUB(NOW(), INTERVAL ? DAY)', [$rows, $syslog_purge]);
-            $final_rows = $rows - $initial_rows;
-            echo "Syslog cleared for entries over $syslog_purge days (about $final_rows rows)\n";
-        }
-        $lock->release();
-    }
-}
-
 if ($options['f'] === 'ports_fdb') {
     $ret = lock_and_purge('ports_fdb', 'updated_at < DATE_SUB(NOW(), INTERVAL ? DAY)');
     exit($ret);

daily.sh

@@ -379,7 +379,6 @@ main () {
                 options=("refresh_alert_rules"
                                "refresh_device_groups"
                                "recalculate_device_dependencies"
-                               "syslog"
                                "eventlog"
                                "authlog"
                                "callback"

lang/en/commands.php

@@ -202,6 +202,9 @@
         'error' => 'Error processing Mac OUI:',
         'vendor_update' => 'Adding OUI :oui for :vendor',
     ],
+    'maintenance:syslog-cleanup' => [
+        'delete' => 'Cleared syslog entries older than :days days (:count rows)',
+    ],
     'plugin:disable' => [
         'description' => 'Disable all plugins with the given name',
         'arguments' => [

routes/console.php

@@ -2,8 +2,10 @@
 
 use App\Console\Commands\MaintenanceCleanupNetworks;
 use App\Console\Commands\MaintenanceFetchOuis;
+use App\Console\Commands\MaintenanceSyslogCleanup;
 use App\Jobs\PingCheck;
 use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Schedule;
 use LibreNMS\Util\Time;
 use Symfony\Component\Process\Process;
@@ -209,3 +211,8 @@
     ->weeklyOn(0, Time::pseudoRandomBetween('02:00', '02:59'))
     ->onOneServer()
     ->appendOutputTo($maintenance_log_file);
+
+Schedule::command(MaintenanceSyslogCleanup::class)
+    ->dailyAt('03:30')
+    ->onOneServer()
+    ->appendOutputTo($maintenance_log_file);