Merge pull request #12056 from nanaya/sentry-metric

Add sentry tracking for slow requests

Author: notbakaneko

.env.example

@@ -326,3 +326,6 @@ CLIENT_CHECK_VERSION=false
 
 # TAGS_CACHE_DURATION=60
 # BEATMAP_TAGS_CACHE_DURATION=60
+
+# OSU_SENTRY_MIN_LOG_DURATION_MS=500
+# SENTRY_TRACES_SAMPLE_RATE=

app/Http/Kernel.php

@@ -16,6 +16,7 @@ class Kernel extends HttpKernel
      */
     protected $middleware = [
         Middleware\DatadogMetrics::class,
+        Middleware\SentryMetrics::class,
     ];
 
     protected $middlewareGroups = [

app/Http/Middleware/DatadogMetrics.php

@@ -12,14 +12,7 @@
 
 class DatadogMetrics extends LaravelDatadogMiddleware
 {
-    /**
-     * Logs the duration of a specific request through the application
-     *
-     * @param Request $request
-     * @param Response $response
-     * @param float $startTime
-     */
-    protected static function logDuration(Request $request, Response $response, $startTime)
+    public static function makeLogTags(Request $request, Response $response): array
     {
         static $hostname;
         if (!isset($hostname)) {
@@ -29,8 +22,7 @@ protected static function logDuration(Request $request, Response $response, $sta
             }
         }
 
-        $duration = microtime(true) - $startTime;
-        $tags = [
+        return [
             'action' => 'error_page',
             'api' => is_api_request() ? 'true' : 'false',
             'controller' => 'error',
@@ -39,9 +31,22 @@ protected static function logDuration(Request $request, Response $response, $sta
             'section' => 'error',
             'status_code' => $response->getStatusCode(),
             'status_code_extra' => $request->attributes->get('status_code_extra'),
+            ...app('route-section')->getOriginal(),
         ];
+    }
 
-        $tags = array_merge($tags, app('route-section')->getOriginal());
+    /**
+     * Logs the duration of a specific request through the application
+     *
+     * @param Request $request
+     * @param Response $response
+     * @param float $startTime
+     */
+    protected static function logDuration(Request $request, Response $response, $startTime)
+    {
+        $tags = static::makeLogTags($request, $response);
+
+        $duration = microtime(true) - $startTime;
 
         Datadog::timing($GLOBALS['cfg']['datadog-helper']['prefix_web'].'.request_time', $duration, 1, $tags);
     }

app/Http/Middleware/SentryMetrics.php

@@ -0,0 +1,38 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+namespace App\Http\Middleware;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class SentryMetrics
+{
+    public function handle(Request $request, \Closure $next): Response
+    {
+        $start = microtime(true);
+
+        $response = $next($request);
+
+        $end = microtime(true);
+        $duration = $end - $start;
+
+        if ($duration > $GLOBALS['cfg']['osu']['sentry']['min_log_duration']) {
+            $data = DatadogMetrics::makeLogTags($request, $response);
+            $name = "{$data['namespace']}/{$data['controller']}:{$data['action']}";
+
+            $transactionContext = \Sentry\Tracing\TransactionContext::make()
+                ->setName($name)
+                ->setData($data)
+                ->setStartTimestamp($start)
+                ->setParentSampled(false)
+                ->setSampled(true);
+
+            \Sentry\startTransaction($transactionContext)->finish($end);
+        }
+
+        return $response;
+    }
+}

composer.json

@@ -43,7 +43,7 @@
     "paypal/paypal-checkout-sdk": "*",
     "reedware/laravel-relation-joins": "^6.0",
     "romanzipp/laravel-turnstile": "^1.3",
-    "sentry/sentry-laravel": "*",
+    "sentry/sentry-laravel": ">=4.13.0",
     "shopify/shopify-api": "^5.6",
     "symfony/yaml": "*",
     "tightenco/ziggy": "^1.8",