feat: Set cache keys as span descriptions (#677)

Author: cleptric

src/Tracing/Cache/TraceableCacheAdapterForV2.php

@@ -48,6 +48,6 @@ public function get(string $key, callable $callback, float $beta = null, array &
             }
 
             return $this->decoratedAdapter->get($key, $callback, $beta, $metadata);
-        });
+        }, $key);
     }
 }

src/Tracing/Cache/TraceableCacheAdapterForV3.php

@@ -46,6 +46,6 @@ public function get(string $key, callable $callback, float $beta = null, array &
             }
 
             return $this->decoratedAdapter->get($key, $callback, $beta, $metadata);
-        });
+        }, $key);
     }
 }

src/Tracing/Cache/TraceableCacheAdapterTrait.php

@@ -40,7 +40,7 @@ public function getItem($key): CacheItem
     {
         return $this->traceFunction('cache.get_item', function () use ($key): CacheItem {
             return $this->decoratedAdapter->getItem($key);
-        });
+        }, $key);
     }
 
     /**
@@ -60,7 +60,7 @@ public function clear(string $prefix = ''): bool
     {
         return $this->traceFunction('cache.clear', function () use ($prefix): bool {
             return $this->decoratedAdapter->clear($prefix);
-        });
+        }, $prefix);
     }
 
     /**
@@ -74,7 +74,7 @@ public function delete(string $key): bool
             }
 
             return $this->decoratedAdapter->delete($key);
-        });
+        }, $key);
     }
 
     /**
@@ -84,7 +84,7 @@ public function hasItem($key): bool
     {
         return $this->traceFunction('cache.has_item', function () use ($key): bool {
             return $this->decoratedAdapter->hasItem($key);
-        });
+        }, $key);
     }
 
     /**
@@ -94,7 +94,7 @@ public function deleteItem($key): bool
     {
         return $this->traceFunction('cache.delete_item', function () use ($key): bool {
             return $this->decoratedAdapter->deleteItem($key);
-        });
+        }, $key);
     }
 
     /**
@@ -168,13 +168,16 @@ public function reset(): void
      *
      * @phpstan-return TResult
      */
-    private function traceFunction(string $spanOperation, \Closure $callback)
+    private function traceFunction(string $spanOperation, \Closure $callback, string $spanDescription = null)
     {
         $span = $this->hub->getSpan();
 
         if (null !== $span) {
             $spanContext = new SpanContext();
             $spanContext->setOp($spanOperation);
+            if (null !== $spanDescription) {
+                $spanContext->setDescription(urldecode($spanDescription));
+            }
 
             $span = $span->startChild($spanContext);
         }

src/Tracing/Cache/TraceableTagAwareCacheAdapterForV2.php

@@ -49,7 +49,7 @@ public function get(string $key, callable $callback, float $beta = null, array &
             }
 
             return $this->decoratedAdapter->get($key, $callback, $beta, $metadata);
-        });
+        }, $key);
     }
 
     /**

src/Tracing/Cache/TraceableTagAwareCacheAdapterForV3.php

@@ -47,7 +47,7 @@ public function get(string $key, callable $callback, float $beta = null, array &
             }
 
             return $this->decoratedAdapter->get($key, $callback, $beta, $metadata);
-        });
+        }, $key);
     }
 
     /**

tests/Tracing/Cache/AbstractTraceableCacheAdapterTest.php

@@ -64,6 +64,7 @@ public function testGetItem(): void
 
         $this->assertCount(2, $spans);
         $this->assertSame('cache.get_item', $spans[1]->getOp());
+        $this->assertSame('foo', $spans[1]->getDescription());
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
@@ -119,6 +120,7 @@ public function testClear(): void
 
         $this->assertCount(2, $spans);
         $this->assertSame('cache.clear', $spans[1]->getOp());
+        $this->assertSame('foo', $spans[1]->getDescription());
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
@@ -148,6 +150,7 @@ public function testGet(): void
 
         $this->assertCount(2, $spans);
         $this->assertSame('cache.get_item', $spans[1]->getOp());
+        $this->assertSame('foo', $spans[1]->getDescription());
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
@@ -185,6 +188,7 @@ public function testDelete(): void
 
         $this->assertCount(2, $spans);
         $this->assertSame('cache.delete_item', $spans[1]->getOp());
+        $this->assertSame('foo', $spans[1]->getDescription());
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
@@ -222,6 +226,7 @@ public function testHasItem(): void
 
         $this->assertCount(2, $spans);
         $this->assertSame('cache.has_item', $spans[1]->getOp());
+        $this->assertSame('foo', $spans[1]->getDescription());
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }
 
@@ -249,6 +254,7 @@ public function testDeleteItem(): void
 
         $this->assertCount(2, $spans);
         $this->assertSame('cache.delete_item', $spans[1]->getOp());
+        $this->assertSame('foo', $spans[1]->getDescription());
         $this->assertNotNull($spans[1]->getEndTimestamp());
     }