[NF] Nagios script to check for any routers stuck in locked state

app/Http/Controllers/Api/V4/RouterController.php

@@ -212,6 +212,56 @@ public function getAllLastUpdatedBefore( int $threshold ): JsonResponse
         return response()->json( $result );
     }
 
+    /**
+     * Find any routers that are stuck in a configuration upgrade / locked for longer than $threashold seconds
+     *
+     * Returns the JSON version of the array:
+     *
+     *     [
+     *         "handle" => [
+     *             "last_update_started"      => "2024-05-23T19:55:29+01:00",
+     *             "last_update_started_unix" => 1716490529,
+     *             "last_updated"             => '2024-05-23T19:55:28+01:00',
+     *             "last_updated_unix"        => 1716490528
+     *          ],
+     *          ...
+     *     ]
+     *
+     * @param int $threshold
+     *
+     * @return JsonResponse
+     */
+    public function getAllLockedLongerThan( int $threshold ): JsonResponse
+    {
+        $result = [];
+        foreach( Router::all() as $r ) {
+
+            if( $r->pause_updates ) {
+                continue; // skip paused routers
+            }
+
+            if( !$r->last_update_started && !$r->last_updated ) {
+                continue; // never updated / never used
+            }
+
+            if( $r->last_update_started && $r->last_updated && $r->last_updated->gte( $r->last_update_started ) ) {
+                continue;
+            }
+
+            if( !$r->last_updated && $r->last_update_started->diffInSeconds( Carbon::now() ) > $threshold ) {
+                $result[ $r->handle ] = $this->lastUpdatedArray( $r );
+                continue;
+            }
+
+            if( $r->last_updated && $r->last_updated->diffInSeconds( $r->last_update_started ) >= $threshold ) {
+                $result[ $r->handle ] = $this->lastUpdatedArray( $r );
+            }
+
+        }
+
+        return response()->json( $result );
+    }
+
     /**
      * Format the router's last updated datetime as an array
      *

routes/apiv4-ext-auth-superuser.php

@@ -93,6 +93,8 @@
 
     Route::get('updated',                                    'RouterController@getAllLastUpdated'       );
     Route::get('updated-before/{threshold}',                 'RouterController@getAllLastUpdatedBefore' );
+
+    Route::get('locked-longer-than/{threshold}',             'RouterController@getAllLockedLongerThan' );
 });
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

tools/runtime/route-servers/nagios-check-locked-routers.php

@@ -0,0 +1,62 @@
+<?php
+
+// Copyright (C) 2009 - 2024 Internet Neutral Exchange Association Company Limited By Guarantee.
+// All Rights Reserved.
+//
+// This file is part of IXP Manager.
+//
+// IXP Manager is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation, version 2.0 of the License.
+//
+// IXP Manager is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License v2.0
+// along with IXP Manager.  If not, see:
+//
+// http://www.gnu.org/licenses/gpl-2.0.html
+//
+
+// variables - you need to change these!
+$key="your-api-key";
+$url="https://ixp.example.com/api/v4/router/locked-longer-than";
+$threshold=7200;
+
+// is curl available?
+if( !function_exists( 'curl_init' ) ) {
+    echo "UNKNOWN: curl not available - install php-curl";
+    exit( 3 );
+}
+
+// get the JSON of routers last updated >$threshold seconds ago
+$s = curl_init();
+curl_setopt( $s, CURLOPT_URL,  $url . '/' . $threshold );
+curl_setopt( $s, CURLOPT_HTTPHEADER, [ 'X-IXP-Manager-API-Key: ' . $key ] );
+curl_setopt( $s, CURLOPT_RETURNTRANSFER, true );
+$json = curl_exec($s);
+
+if( !curl_getinfo($s,CURLINFO_HTTP_CODE) == 200 ) {
+    echo "UNKNOWN: non-200 status code returned by API: " . curl_getinfo($s,CURLINFO_HTTP_CODE) . "\n";
+    exit( 3 );
+}
+
+if( $json === "[]" ) {
+    echo sprintf( "OK: no routers stuck mid-configuration for >%d seconds\n", $threshold );
+    exit(0);
+}
+
+if( !( $routers = json_decode( $json ) ) ) {
+    echo "UNKNOWN: could not decode JSON response from API\n";
+    exit( 3 );
+}
+
+$bad     = [];
+foreach( $routers as $handle => $r ) {
+    $bad[] = $handle;
+}
+
+echo 'ERROR: the following router(s) have been locked for more than ' . $threshold . 'secs: ' . implode( ', ', $bad ) . ".\n";
+exit(2);