Trace Larvel cache actions (#35)

* Added support for expoing Cache actions within X-Ray

* Update README.md

* Fixes for styleci

README.md

@@ -185,6 +185,7 @@ XRAY_ENABLED=false
 - [x] Database queries
 - [x] Queue jobs
 - [x] Blade view render
+- [x] Cache requests
 
 
 ## LICENSE

config/xray.php

@@ -58,6 +58,13 @@
     */
     'framework' => env('XRAY_FRAMEWORK', true),
 
+    /*
+    |--------------------------------------------------------------------------
+    | Trace Cache
+    |--------------------------------------------------------------------------
+    */
+    'cache' => env('XRAY_CACHE', true),
+
     /*
     |--------------------------------------------------------------------------
     | AWS, only needed if "APISegmentSubmitter" submitter is chosen

src/Collectors/CacheCollector.php

@@ -0,0 +1,43 @@
+<?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 Illuminate\Redis\Events\CommandExecuted;
+
+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');
+        });
+        $this->app->events->listen(CommandExecuted::class, function (CommandExecuted $cache) {
+            $this->handleQueryReport($cache->command, 'Cache redis command executed');
+        });
+    }
+
+    protected function handleQueryReport(string $cacheKey, string $eventName): void
+    {
+        $backtrace = $this->getBacktrace();
+        $this
+            ->addSegment($eventName . ' at ' . $this->getCallerClass($backtrace))
+            ->addAnnotation('Key', $cacheKey)
+            ->addMetadata('backtrace', $backtrace)
+            ->end();
+    }
+}