Fixes

src/Zipkin/ErrorParser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Zipkin;
 
 use Zipkin\Recording\Span;
@@ -12,5 +14,11 @@
  */
 interface ErrorParser
 {
+    /**
+     * Parses the error into a set of tags.
+     *
+     * @param Throwable $e
+     * @return array<string,string>
+     */
     public function parseTags(Throwable $e): array;
 }

src/Zipkin/Instrumentation/Http/Client/HttpClientTracing.php

@@ -27,8 +27,8 @@ class HttpClientTracing
 
     public function __construct(
         Tracing $tracing,
-        HttpClientParser $parser = null,
-        callable $requestSampler = null
+        ?HttpClientParser $parser = null,
+        ?callable $requestSampler = null
     ) {
         $this->tracing = $tracing;
         $this->parser = $parser ?? new DefaultHttpClientParser();

src/Zipkin/Instrumentation/Http/Server/HttpServerTracing.php

@@ -26,8 +26,8 @@ class HttpServerTracing
 
     public function __construct(
         Tracing $tracing,
-        HttpServerParser $parser = null,
-        callable $requestSampler = null
+        ?HttpServerParser $parser = null,
+        ?callable $requestSampler = null
     ) {
         $this->tracing = $tracing;
         $this->parser = $parser ?? new DefaultHttpServerParser();

src/Zipkin/Instrumentation/Mysqli/Mysqli.php

@@ -6,8 +6,8 @@
 use const Zipkin\Tags\ERROR;
 use Zipkin\Tracer;
 use Zipkin\Span;
-
 use Zipkin\Endpoint;
+use Zipkin\Kind;
 use InvalidArgumentException;
 
 /**
@@ -24,202 +24,218 @@ final class Mysqli extends \Mysqli
     ];
 
     private Tracer $tracer;
-
     private array $options;
 
     public function __construct(
         Tracer $tracer,
         array $options = [],
-        string $host = null,
-        string $user = null,
-        string $password = null,
+        ?string $host = null,
+        ?string $user = null,
+        ?string $password = null,
         string $database = '',
-        int $port = null,
-        string $socket = null
+        ?int $port = null,
+        ?string $socket = null
     ) {
         self::validateOptions($options);
         $this->tracer = $tracer;
         $this->options = $options + self::DEFAULT_OPTIONS;
+
+        $defaultHost = \ini_get('mysqli.default_host') ?: '';
+        $defaultUser = \ini_get('mysqli.default_user') ?: '';
+        $defaultPassword = \ini_get('mysqli.default_pw') ?: '';
+        $defaultPort = (int) (\ini_get('mysqli.default_port') ?: 3306);
+        $defaultSocket = \ini_get('mysqli.default_socket') ?: '';
+
         parent::__construct(
-            $host ?? (ini_get('mysqli.default_host') ?: ''),
-            $user ?? (ini_get('mysqli.default_user') ?: ''),
-            $password ?? (ini_get('mysqli.default_pw') ?: ''),
+            $host ?? $defaultHost,
+            $user ?? $defaultUser,
+            $password ?? $defaultPassword,
             $database,
-            $port ?? (($defaultPort = ini_get('mysqli.default_port')) ? (int) $defaultPort : 3306),
-            $socket ?? (ini_get('mysqli.default_socket') ?: '')
+            $port ?? $defaultPort,
+            $socket ?? $defaultSocket
         );
     }
 
-    private static function validateOptions(array $opts): void
+    /**
+     * {@inheritdoc}
+     */
+    public function query(string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool
     {
-        if (array_key_exists('tag_query', $opts) && ($opts['tag_query'] !== (bool) $opts['tag_query'])) {
-            throw new InvalidArgumentException('Invalid tag_query, bool expected');
-        }
-
-        if (array_key_exists('remote_endpoint', $opts) && !($opts['remote_endpoint'] instanceof Endpoint)) {
-            throw new InvalidArgumentException(sprintf('Invalid remote_endpoint, %s expected', Endpoint::class));
-        }
-
-        if (array_key_exists('default_tags', $opts) && ($opts['default_tags'] !== (array) $opts['default_tags'])) {
-            throw new InvalidArgumentException('Invalid default_tags, array expected');
-        }
-    }
+        $span = $this->tracer->nextSpan();
+        $span->start();
+        $span->setName('query');
+        $span->setKind(Kind\CLIENT);
 
-    private function addsTagsAndRemoteEndpoint(Span $span, string $query = null): void
-    {
-        if ($query !== null && $this->options['tag_query']) {
+        if ($this->options['tag_query']) {
             $span->tag('sql.query', $query);
         }
 
-        if ($this->options['remote_endpoint'] !== null) {
-            $span->setRemoteEndpoint($this->options['remote_endpoint']);
-        }
-
         foreach ($this->options['default_tags'] as $key => $value) {
             $span->tag($key, $value);
         }
-    }
-
-    /**
-     * Performs a query on the database
-     *
-     * @return mysqli_result|bool
-     * @alias mysqli_query
-     */
-    public function query(string $query, int $resultmode = MYSQLI_STORE_RESULT)
-    {
-        if ($resultmode === MYSQLI_ASYNC) {
-            // if $resultmode is async, making the timing on this execution
-            // does not make much sense. For now we just skip tracing on this.
-            return parent::query($query, $resultmode);
-        }
 
-        $span = $this->tracer->nextSpan();
-        $span->setName('sql/query');
-        $this->addsTagsAndRemoteEndpoint($span, $query);
-        if ($this->options['tag_query']) {
-            $span->tag('sql.query', $query);
+        if ($this->options['remote_endpoint'] !== null) {
+            $span->setRemoteEndpoint($this->options['remote_endpoint']);
         }
 
-        $span->start();
         try {
-            $result = parent::query($query, $resultmode);
+            $result = parent::query($query, $result_mode);
             if ($result === false) {
-                $span->tag(ERROR, 'true');
+                $span->tag(ERROR, $this->error);
             }
             return $result;
+        } catch (\Throwable $e) {
+            $span->tag(ERROR, $e->getMessage());
+            throw $e;
         } finally {
             $span->finish();
         }
     }
 
     /**
-     * @return bool
-     * @alias mysqli_real_query
+     * {@inheritdoc}
      */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName
-    public function real_query(string $query)
+    public function real_query(string $query): bool
     {
         $span = $this->tracer->nextSpan();
-        $span->setName('sql/query');
-        $this->addsTagsAndRemoteEndpoint($span, $query);
-
         $span->start();
+        $span->setName('real_query');
+        $span->setKind(Kind\CLIENT);
+
+        if ($this->options['tag_query']) {
+            $span->tag('sql.query', $query);
+        }
+
+        foreach ($this->options['default_tags'] as $key => $value) {
+            $span->tag($key, $value);
+        }
+
+        if ($this->options['remote_endpoint'] !== null) {
+            $span->setRemoteEndpoint($this->options['remote_endpoint']);
+        }
+
         try {
             $result = parent::real_query($query);
             if ($result === false) {
-                $span->tag(ERROR, 'true');
+                $span->tag(ERROR, $this->error);
             }
             return $result;
+        } catch (\Throwable $e) {
+            $span->tag(ERROR, $e->getMessage());
+            throw $e;
         } finally {
             $span->finish();
         }
     }
 
     /**
      * {@inheritdoc}
-     * @alias mysqli_begin_transaction
      */
-    // phpcs:ignore PSR1.Methods.CamelCapsMethodName
-    public function begin_transaction($flags = 0, $name = null)
+    public function begin_transaction(int $flags = 0, ?string $name = null): bool
     {
         $span = $this->tracer->nextSpan();
-        $span->setName('sql/begin_transaction');
-        $this->addsTagsAndRemoteEndpoint($span);
         $span->start();
-        if ($name !== null) {
-            $span->tag('mysqli.transaction_name', (string) $name);
+        $span->setName('begin_transaction');
+        $span->setKind(Kind\CLIENT);
+
+        foreach ($this->options['default_tags'] as $key => $value) {
+            $span->tag($key, $value);
         }
-        try {
-            if ($name === null) {
-                $result = parent::begin_transaction($flags);
-            } else {
-                $result = parent::begin_transaction($flags, $name);
-            }
 
+        if ($this->options['remote_endpoint'] !== null) {
+            $span->setRemoteEndpoint($this->options['remote_endpoint']);
+        }
+
+        try {
+            $result = parent::begin_transaction($flags, $name);
             if ($result === false) {
-                $span->tag(ERROR, 'true');
+                $span->tag(ERROR, $this->error);
             }
             return $result;
+        } catch (\Throwable $e) {
+            $span->tag(ERROR, $e->getMessage());
+            throw $e;
         } finally {
             $span->finish();
         }
     }
 
     /**
-     * @return bool
-     * @alias mysqli_commit
+     * {@inheritdoc}
      */
-    public function commit(int $flags = -1, ?string $name = null)
+    public function commit(int $flags = 0, ?string $name = null): bool
     {
         $span = $this->tracer->nextSpan();
-        $span->setName('sql/begin_transaction');
-        $this->addsTagsAndRemoteEndpoint($span);
         $span->start();
-        if ($name !== null) {
-            $span->tag('mysqli.transaction_name', $name);
+        $span->setName('commit');
+        $span->setKind(Kind\CLIENT);
+
+        foreach ($this->options['default_tags'] as $key => $value) {
+            $span->tag($key, $value);
         }
-        try {
-            if ($name === null) {
-                $result = parent::commit($flags);
-            } else {
-                $result = parent::commit($flags, $name);
-            }
 
+        if ($this->options['remote_endpoint'] !== null) {
+            $span->setRemoteEndpoint($this->options['remote_endpoint']);
+        }
+
+        try {
+            $result = parent::commit($flags, $name);
             if ($result === false) {
-                $span->tag(ERROR, 'true');
+                $span->tag(ERROR, $this->error);
             }
             return $result;
+        } catch (\Throwable $e) {
+            $span->tag(ERROR, $e->getMessage());
+            throw $e;
         } finally {
             $span->finish();
         }
     }
 
     /**
      * {@inheritdoc}
-     * @alias mysqli_rollback
      */
-    public function rollback($flags = 0, $name = null)
+    public function rollback(int $flags = 0, ?string $name = null): bool
     {
         $span = $this->tracer->nextSpan();
-        $span->setName('sql/rollback');
-        $this->addsTagsAndRemoteEndpoint($span);
         $span->start();
-        if ($name !== null) {
-            $span->tag('mysqli.transaction_name', (string) $name);
+        $span->setName('rollback');
+        $span->setKind(Kind\CLIENT);
+
+        foreach ($this->options['default_tags'] as $key => $value) {
+            $span->tag($key, $value);
         }
+
+        if ($this->options['remote_endpoint'] !== null) {
+            $span->setRemoteEndpoint($this->options['remote_endpoint']);
+        }
+
         try {
-            if ($name === null) {
-                $result = parent::commit($flags);
-            } else {
-                $result = parent::commit($flags, $name);
-            }
+            $result = parent::rollback($flags, $name);
             if ($result === false) {
-                $span->tag(ERROR, 'true');
+                $span->tag(ERROR, $this->error);
             }
             return $result;
+        } catch (\Throwable $e) {
+            $span->tag(ERROR, $e->getMessage());
+            throw $e;
         } finally {
             $span->finish();
         }
     }
+
+    private static function validateOptions(array $opts): void
+    {
+        if (isset($opts['remote_endpoint']) && !$opts['remote_endpoint'] instanceof Endpoint) {
+            throw new InvalidArgumentException(
+                \sprintf('Invalid remote_endpoint. Expected Endpoint, got %s', \gettype($opts['remote_endpoint']))
+            );
+        }
+
+        if (isset($opts['default_tags']) && !\is_array($opts['default_tags'])) {
+            throw new InvalidArgumentException(
+                \sprintf('Invalid default_tags. Expected array, got %s', \gettype($opts['default_tags']))
+            );
+        }
+    }
 }

src/Zipkin/Kind.php

@@ -28,3 +28,11 @@
 * #PRODUCER} of this message is the {@link TraceContext#parentId()} of this span.
 */
 const CONSUMER = 'CONSUMER';
+
+
+class Kind {
+    const CLIENT = 'CLIENT';
+    const SERVER = 'SERVER';
+    const PRODUCER = 'PRODUCER';
+    const CONSUMER = 'CONSUMER';
+}