feat(cp): add cache support (#22)

cherry-pick from Napp#35

config/xray.php

@@ -91,6 +91,13 @@
     */
     'framework' => env('AWS_XRAY_ENABLE_FRAMEWORK', true),
 
+    /*
+    |--------------------------------------------------------------------------
+    | Trace Cache
+    |--------------------------------------------------------------------------
+    */
+    'cache' => env('XRAY_CACHE', true),
+
     /*
     |--------------------------------------------------------------------------
     | Sampled Rate If Not Receiving Header

src/Collectors/CacheCollector.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Napp\Xray\Collectors;
+
+use Illuminate\Cache\Events\CacheHit;
+use Illuminate\Cache\Events\CacheMissed;
+use Illuminate\Cache\Events\KeyForgotten;
+use Illuminate\Cache\Events\KeyWritten;
+use Pkerrigan\Xray\Segment;
+
+class CacheCollector extends EventsCollector
+{
+    public function registerEventListeners(): void
+    {
+        $this->app->events->listen(CacheHit::class, function (CacheHit $cache) {
+            $this->handleQueryReport($cache->key, 'Cache hit');
+        });
+        $this->app->events->listen(CacheMissed::class, function (CacheMissed $cache) {
+            $this->handleQueryReport($cache->key, 'Cache miss');
+        });
+        $this->app->events->listen(KeyWritten::class, function (KeyWritten $cache) {
+            $this->handleQueryReport($cache->key, 'Cache set');
+        });
+        $this->app->events->listen(KeyForgotten::class, function (KeyForgotten $cache) {
+            $this->handleQueryReport($cache->key, 'Cache delete');
+        });
+    }
+
+    protected function handleQueryReport(string $cacheKey, string $eventName): void
+    {
+        $backtrace = $this->getBacktrace();
+        $segment = (new Segment())->setName($eventName . ' at ' . $this->getCallerClass($backtrace));
+
+        $this
+            ->addSegment($segment)
+            ->addAnnotation('Key', $cacheKey)
+            ->addMetadata('backtrace', $backtrace)
+            ->end();
+    }
+}

src/XrayServiceProvider.php

@@ -5,6 +5,7 @@
 namespace Napp\Xray;
 
 use Illuminate\Support\ServiceProvider;
+use Napp\Xray\Collectors\CacheCollector;
 use Napp\Xray\Collectors\DatabaseQueryCollector;
 use Napp\Xray\Collectors\FrameworkCollector;
 use Napp\Xray\Collectors\JobCollector;
@@ -68,6 +69,10 @@ protected function registerCollectors(): void
         if (config('xray.framework')) {
             app(FrameworkCollector::class);
         }
+
+        if (config('xray.cache')) {
+            app(CacheCollector::class);
+        }
     }
 
     /**