Merge branch '3.0.x'

Author: allflame

README.md

@@ -1,19 +1,23 @@
-
 # PHP OpenTracing API using Jaeger 
 
-
 ## Installation
 
-```
+```bash
 composer require code-tool/jaeger-client-php
 ```
 
 ## Getting Started
 
-It is strictly advised to use any form of DI container (e.g. [Symfony](https://github.com/code-tool/jaeger-client-symfony-bridge)).
-```$xslt
+It is strictly advised to use any form of DI container (e.g. [Symfony Bundle](https://github.com/code-tool/jaeger-client-symfony-bridge)).
+
+```php
 <?php
 
+use Jaeger\Tag\StringTag;
+use Jaeger\Tracer\TracerInterface;
+
+/** @var TracerInterface $tracer */
+
 $span = $tracer->start('Parent Operation Name', [new StringTag('test.tag', 'Hello world in parent')]);
 $childSpan = $tracer->start('Child Operation Name', [new StringTag('test.tag', 'Hello world in child')]);
 $tracer->finish($childSpan);

bin/thrift-gen.sh

@@ -1,9 +1,9 @@
-#!/bin/sh
+#!/bin/bash
 set -e
 
 cd "$(dirname "$0")/.."
 
-git clone https://github.com/uber/jaeger-idl
+git clone https://github.com/jaegertracing/jaeger-idl
 pushd jaeger-idl
 
 rm -rf ../src/Thrift

composer.json

@@ -8,8 +8,8 @@
   },
   "require": {
     "php": ">=7.1",
-    "apache/thrift": "0.11.*",
-    "psr/log": "^1.0.2"
+    "ext-sockets": "*",
+    "apache/thrift": ">=0.11, <0.16"
   },
   "require-dev": {
     "phpunit/phpunit": "@stable"

src/Client/ThriftClient.php

@@ -12,18 +12,21 @@
 
 class ThriftClient implements ClientInterface
 {
-    const MAX_BATCH_SIZE = 100;
+    public const MAX_BATCH_SIZE = 32;
 
     private $serviceName;
 
     private $agent;
 
+    private $batch;
+
     private $spans = [];
 
-    public function __construct(string $serviceName, AgentInterface $agent)
+    public function __construct(string $serviceName, AgentInterface $agent, $batch = self::MAX_BATCH_SIZE)
     {
         $this->serviceName = $serviceName;
         $this->agent = $agent;
+        $this->batch = (int)$batch;
     }
 
     public function add(SpanInterface $span): ClientInterface
@@ -51,7 +54,7 @@ public function flush(): ClientInterface
                 $process = new FpmProcess($this->serviceName);
                 break;
         }
-        foreach (array_chunk($this->spans, self::MAX_BATCH_SIZE) as $batch) {
+        foreach (array_chunk($this->spans, $this->batch) as $batch) {
             $this->agent->emitBatch(new SpanBatch($process, $batch));
         }
         $this->spans = [];

src/Codec/CodecRegistry.php

@@ -7,11 +7,19 @@ class CodecRegistry implements \ArrayAccess
 {
     private $codecs = [];
 
+    /**
+     * @return bool
+     */
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return array_key_exists($offset, $this->codecs);
     }
 
+    /**
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         if (false === array_key_exists($offset, $this->codecs)) {
@@ -21,13 +29,21 @@ public function offsetGet($offset)
         return $this->codecs[$offset];
     }
 
+    /**
+     * @return $this
+     */
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         $this->codecs[$offset] = $value;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         if (false === array_key_exists($offset, $this->codecs)) {

src/Sampler/OperationGenerator.php

@@ -7,6 +7,6 @@ class OperationGenerator implements GeneratorInterface
 {
     public function generate(int $traceId, string $operationName): string
     {
-        return $operationName;
+        return 'operation:' . $operationName;
     }
 }

src/Span/Context/SpanContext.php

@@ -44,6 +44,11 @@ public function getParentId(): int
         return $this->parentId;
     }
 
+    public function isSampled(): bool
+    {
+        return (bool)($this->flags & 0x01);
+    }
+
     public function isDebug(): bool
     {
         return (bool)($this->flags & 0x02);
@@ -59,6 +64,10 @@ public function getBaggage(): array
         return $this->baggage;
     }
 
+    /**
+     * @return \Traversable
+     */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \ArrayIterator($this->baggage);

src/Span/Span.php

@@ -8,7 +8,7 @@
 use Jaeger\Tag\OutOfScopeTag;
 use Jaeger\Thrift\Log;
 use Jaeger\Thrift\Tag;
-use Jaeger\Tracer\TracerInterface;
+use Jaeger\Tracer\FinishableInterface;
 
 class Span extends \Jaeger\Thrift\Span implements SpanInterface
 {
@@ -17,7 +17,7 @@ class Span extends \Jaeger\Thrift\Span implements SpanInterface
     private $context;
 
     public function __construct(
-        TracerInterface $tracer,
+        FinishableInterface $tracer,
         SpanContext $context,
         string $operationName,
         int $startTime,
@@ -33,7 +33,6 @@ public function __construct(
         $this->flags = $context->getFlags();
         $this->operationName = $operationName;
         $this->startTime = $startTime;
-
         $this->tags = $tags;
         $this->logs = $logs;
         parent::__construct();
@@ -42,14 +41,11 @@ public function __construct(
     public function __destruct()
     {
         if (null !== $this->duration) {
-            return $this;
+            return;
         }
         $this->tags[] = new ErrorTag();
         $this->tags[] = new OutOfScopeTag();
-
         $this->tracer->finish($this);
-
-        return $this;
     }
 
     public function getContext(): ?SpanContext
@@ -59,7 +55,7 @@ public function getContext(): ?SpanContext
 
     public function isSampled(): bool
     {
-        return (bool)($this->flags & 1);
+        return $this->context->isSampled();
     }
 
     public function start(int $startTimeUsec): SpanInterface
@@ -71,10 +67,8 @@ public function start(int $startTimeUsec): SpanInterface
 
     public function finish(int $durationUsec = 0): SpanInterface
     {
-        if (0 === $durationUsec) {
-            $durationUsec = (int)(microtime(true) * 1000000) - $this->startTime;
-        }
-        $this->duration = $durationUsec;
+        $this->duration = $durationUsec ?: (microtime(true) * 1000000) - $this->startTime;
+        $this->tracer->finish($this, -1);
 
         return $this;
     }

src/Span/SpanAwareInterface.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Span;
+
+interface SpanAwareInterface
+{
+    public function getSpan(): ?SpanInterface;
+}

src/Span/SpanManagerInterface.php

@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace Jaeger\Span;
+
+use Jaeger\Span\Context\ContextAwareInterface;
+use Jaeger\Tracer\InjectableInterface;
+use Jaeger\Tracer\ResettableInterface;
+
+interface SpanManagerInterface extends ContextAwareInterface,
+                                       InjectableInterface,
+                                       ResettableInterface,
+                                       SpanAwareInterface
+{
+    public function new(SpanInterface $span);
+
+    public function finish(SpanInterface $span): ?SpanInterface;
+}