Release v11.9.1 - Added API metrics tracking

app/Http/Kernel.php

@@ -2,7 +2,7 @@
 
 namespace App\Http;
 
-use App\Http\Middleware\ApiAuthentication;
+use App\Http\Middleware\Api\ApiAuthentication;
 use App\Http\Middleware\DebugBarMessageLogger;
 use App\Http\Middleware\DebugInfoContextLogger;
 use App\Http\Middleware\EncryptCookies;

app/Http/Middleware/ApiAuthentication.php → app/Http/Middleware/Api/ApiAuthentication.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Http\Middleware;
+namespace App\Http\Middleware\Api;
 
 use App\Service\User\UserServiceInterface;
 use Closure;

app/Http/Middleware/Api/ApiMetrics.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Http\Middleware\Api;
+
+use App\Models\Metrics\Metric;
+use App\Service\Metric\MetricServiceInterface;
+use Auth;
+use Closure;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class ApiMetrics
+{
+    public function __construct(private readonly MetricServiceInterface $metricService)
+    {
+    }
+
+    /**
+     * Handle an incoming request.
+     */
+    public function handle(Request $request, Closure $next): Response
+    {
+        if (!app()->runningUnitTests()) {
+            $this->metricService->storeMetricByModel(
+                Auth::user(),
+                Metric::CATEGORY_API_CALL,
+                $request->path(),
+                1
+            );
+        }
+
+        return $next($request);
+    }
+}

app/Models/Metrics/Metric.php

@@ -27,13 +27,14 @@ class Metric extends Model
     use HasGenericModelRelation;
 
     public const CATEGORY_DUNGEON_ROUTE_MDT_COPY = 1;
+    public const CATEGORY_API_CALL               = 10;
 
     public const ALL_CATEGORIES = [
         self::CATEGORY_DUNGEON_ROUTE_MDT_COPY,
+        self::CATEGORY_API_CALL,
     ];
 
-    public const TAG_MDT_COPY_VIEW = 'view';
-
+    public const TAG_MDT_COPY_VIEW  = 'view';
     public const TAG_MDT_COPY_EMBED = 'embed';
 
     public const ALL_TAGS = [

app/Providers/RouteServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace App\Providers;
 
+use App\Http\Middleware\Api\ApiMetrics;
 use App\Models\Laratrust\Role;
 use App\Models\User;
 use Illuminate\Cache\RateLimiting\Limit;
@@ -57,7 +58,7 @@ protected function mapWebRoutes(): void
     protected function mapApiRoutes(): void
     {
         Route::prefix('api')
-            ->middleware(['api', 'throttle:api-general'])
+            ->middleware(['api', 'throttle:api-general', ApiMetrics::class])
             ->group(base_path('routes/api.php'));
     }
 
@@ -108,7 +109,7 @@ private function configureApiRateLimiting(): void
             return $this->noLimitForExemptionsApi($request) ?? Limit::perMinute(self::RATE_LIMIT_OVERRIDE_PER_MINUTE_API ?? 120)->by($this->userKey($request));
         });
         RateLimiter::for('api-combatlog-correct-event', function (Request $request) {
-            return $this->noLimitForExemptionsApi($request) ?? Limit::perMinute(self::RATE_LIMIT_OVERRIDE_PER_MINUTE_API ?? 5)->by($this->userKey($request));
+            return $this->noLimitForExemptionsApi($request) ?? Limit::perMinute(self::RATE_LIMIT_OVERRIDE_PER_MINUTE_API ?? 240)->by($this->userKey($request));
         });
         RateLimiter::for('api-create-dungeonroute-thumbnail', function (Request $request) {
             return $this->noLimitForExemptionsApi($request) ?? Limit::perMinute(self::RATE_LIMIT_OVERRIDE_PER_MINUTE_API ?? 30)->by($this->userKey($request));

app/Service/Metric/MetricService.php

@@ -21,11 +21,11 @@ public function storeMetric(?int $modelId, ?string $modelClass, int $category, s
         ]);
     }
 
-    public function storeMetricByModel(Model $model, int $category, string $tag, int $value): Metric
+    public function storeMetricByModel(?Model $model, int $category, string $tag, int $value): Metric
     {
         return Metric::create([
-            'model_id'    => $model->id,
-            'model_class' => $model::class,
+            'model_id'    => $model?->id,
+            'model_class' => $model !== null ? $model::class : null,
             'category'    => $category,
             'tag'         => $tag,
             'value'       => $value,

app/Service/Metric/MetricServiceInterface.php

@@ -9,7 +9,7 @@ interface MetricServiceInterface
 {
     public function storeMetric(?int $modelId, ?string $modelClass, int $category, string $tag, int $value): Metric;
 
-    public function storeMetricByModel(Model $model, int $category, string $tag, int $value): Metric;
+    public function storeMetricByModel(?Model $model, int $category, string $tag, int $value): Metric;
 
     public function aggregateMetrics(): bool;
 }

database/seeders/releases/v11.9.1.json

@@ -0,0 +1,25 @@
+{
+    "id": 267,
+    "release_changelog_id": 274,
+    "version": "v11.9.1",
+    "title": "Added API metrics tracking",
+    "backup_db": 1,
+    "silent": 1,
+    "spotlight": 0,
+    "released": 0,
+    "created_at": "2025-01-20T21:38:53+00:00",
+    "updated_at": "2025-01-20T21:38:53+00:00",
+    "changelog": {
+        "id": 274,
+        "release_id": 267,
+        "description": null,
+        "changes": [
+            {
+                "release_changelog_id": 274,
+                "release_changelog_category_id": 12,
+                "ticket_id": 2664,
+                "change": "API calls are now tracked and graphed so I can get some insight in how it's being used."
+            }
+        ]
+    }
+}