feat(http-server): adds middleware instrumentation.

README.md

@@ -294,7 +294,8 @@ request. To do this, simply pass null to `openScope`.
 
 ## Instrumentation
 
-- [PSR18 HTTP Client](src/Zipkin/Instrumentation/Http/Client)
+- [PSR18 HTTP Client](src/Zipkin/Instrumentation/Http/Client/Psr18)
+- [PSR15 HTTP Server](src/Zipkin/Instrumentation/Http/Server/Psr15)
 
 ## Tests
 

composer.json

@@ -4,28 +4,36 @@
     "description": "A Zipkin instrumentation for PHP",
     "keywords": [
         "zipkin",
+        "distributed-tracing",
         "tracing",
         "openzipkin"
     ],
-    "license": "MIT",
+    "license": "Apache-2.0",
     "authors": [
         {
             "name": "José Carlos Chávez",
             "email": "[email protected]"
         }
     ],
+    "homepage": "https://github.com/openzipkin/zipkin-php",
+    "support": {
+        "issues": "https://github.com/openzipkin/zipkin-php/issues"
+    },
     "require": {
         "php": "^7.1",
         "ext-curl": "*",
         "psr/http-message": "~1.0",
         "psr/log": "^1.0"
     },
     "require-dev": {
-        "guzzlehttp/psr7": "^1.4",
+        "guzzlehttp/psr7": "^1.6",
         "jcchavezs/httptest": "~0.2",
         "phpstan/phpstan": "~0.12.28",
         "phpunit/phpunit": "~7.5.20",
         "psr/http-client": "^1.0",
+        "psr/http-server-middleware": "^1.0",
+        "middlewares/fast-route": "^1.2.1",
+        "middlewares/request-handler": "^1.4.0",
         "squizlabs/php_codesniffer": "3.*"
     },
     "config": {
@@ -60,7 +68,8 @@
         "static-check": "phpstan analyse src --level 8"
     },
     "suggest": {
-        "psr/http-client": "Allows to instrument HTTP clients following PSR18."
+        "psr/http-client": "Allows to instrument HTTP clients following PSR18.",
+        "psr/http-server-middleware": "Allows to instrument HTTP servers via middlewares following PSR15."
     },
     "extra": {
         "branch-alias": {

phpstan.neon

@@ -29,11 +29,7 @@ parameters:
 			# In general types are desired but carrier is an special case
 			message: '#has parameter \$carrier with no typehint specified#'
 			path: src/Zipkin/*
-		-  
-			# Somehow this started failing
-			message: '#Constant .* already defined#'
-			path: src/Zipkin
 		-
 			# SpanCustomizer is definitively not null
 			message: '#Parameter \#3 \$ of callable callable\(.*, Zipkin\\Propagation\\TraceContext, Zipkin\\SpanCustomizer\): void expects Zipkin\\SpanCustomizer, Zipkin\\SpanCustomizerShield\|null given.#'
-			path: src/Zipkin/Tracer
+			path: src/Zipkin/Tracer

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

@@ -7,28 +7,48 @@
 use Zipkin\Tags;
 use Zipkin\SpanCustomizer;
 use Zipkin\Propagation\TraceContext;
-use Throwable;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\RequestInterface;
+use Zipkin\Instrumentation\Http\Response;
+use Zipkin\Instrumentation\Http\Request;
+use Zipkin\Instrumentation\Http\Client\Parser;
 
+/**
+ * DefaultParser contains the basic logic for turning request/response information
+ * into span name and tags. Implementors can use this as a base parser to reduce
+ * boilerplate.
+ */
 class DefaultParser implements Parser
 {
-    public function spanName(RequestInterface $request): string
+    /**
+     * spanName returns an appropiate span name based on the request,
+     * usually the HTTP method is enough (e.g GET or POST).
+     */
+    protected function spanName(Request $request): string
     {
         return $request->getMethod();
     }
 
-    public function request(RequestInterface $request, TraceContext $context, SpanCustomizer $span): void
+    /**
+     * {@inhertidoc}
+     */
+    public function request(Request $request, TraceContext $context, SpanCustomizer $span): void
     {
+        $span->setName($this->spanName($request));
         $span->tag(Tags\HTTP_METHOD, $request->getMethod());
-        $span->tag(Tags\HTTP_PATH, $request->getUri()->getPath() ?: "/");
+        $span->tag(Tags\HTTP_PATH, $request->getPath() ?: "/");
     }
 
-    public function response(ResponseInterface $response, TraceContext $context, SpanCustomizer $span): void
+    /**
+     * {@inhertidoc}
+     */
+    public function response(Response $response, TraceContext $context, SpanCustomizer $span): void
     {
-        $span->tag(Tags\HTTP_STATUS_CODE, (string) $response->getStatusCode());
-        if ($response->getStatusCode() > 399) {
-            $span->tag(Tags\ERROR, (string) $response->getStatusCode());
+        $statusCode = $response->getStatusCode();
+        if ($statusCode < 200 || $statusCode > 299) {
+            $span->tag(Tags\HTTP_STATUS_CODE, (string) $statusCode);
+        }
+
+        if ($statusCode > 399) {
+            $span->tag(Tags\ERROR, (string) $statusCode);
         }
     }
 }

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

@@ -5,13 +5,13 @@
 namespace Zipkin\Instrumentation\Http\Client;
 
 use Zipkin\Tracing;
-use Psr\Http\Message\RequestInterface;
+use Zipkin\Instrumentation\Http\Request;
 
 /**
  * ClientTracing includes all the elements needed to instrument a
  * HTTP client.
  */
-class ClientTracing
+class HttpClientTracing
 {
     /**
      * @var Tracing
@@ -25,13 +25,9 @@ class ClientTracing
 
     /**
      * function that decides to sample or not an unsampled
-     * request. The signature is:
+     * request.
      *
-     * <pre>
-     * function (RequestInterface $request): ?bool {}
-     * </pre>
-     *
-     * @var callable(RequestInterface):?bool|null
+     * @var callable(Request):?bool|null
      */
     private $requestSampler;
 
@@ -51,7 +47,7 @@ public function getTracing(): Tracing
     }
 
     /**
-     * @return (callable(RequestInterface):?bool)|null
+     * @return (callable(Request):?bool)|null
      */
     public function getRequestSampler(): ?callable
     {

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

@@ -6,30 +6,23 @@
 
 use Zipkin\SpanCustomizer;
 use Zipkin\Propagation\TraceContext;
-use Throwable;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\RequestInterface;
+use Zipkin\Instrumentation\Http\Response;
+use Zipkin\Instrumentation\Http\Request;
 
 /**
  * Parser includes the methods to obtain meaningful span information
  * out of HTTP request/response elements.
  */
 interface Parser
 {
-    /**
-     * spanName returns an appropiate span name based on the request,
-     * usually the HTTP method is good enough (e.g GET or POST).
-     */
-    public function spanName(RequestInterface $request): string;
-
     /**
      * request parses the incoming data related to a request in order to add
      * relevant information to the span under the SpanCustomizer interface.
      *
      * Basic data being tagged is HTTP method, HTTP path but other information
      * such as query parameters can be added to enrich the span information.
      */
-    public function request(RequestInterface $request, TraceContext $context, SpanCustomizer $span): void;
+    public function request(Request $request, TraceContext $context, SpanCustomizer $span): void;
 
 
     /**
@@ -40,5 +33,5 @@ public function request(RequestInterface $request, TraceContext $context, SpanCu
      * as any response header or more granular information based on the response
      * payload can be added.
      */
-    public function response(ResponseInterface $response, TraceContext $context, SpanCustomizer $span): void;
+    public function response(Response $response, TraceContext $context, SpanCustomizer $span): void;
 }

src/Zipkin/Instrumentation/Http/Client/Client.php → src/Zipkin/Instrumentation/Http/Client/Psr18/Client.php

@@ -2,12 +2,15 @@
 
 declare(strict_types=1);
 
-namespace Zipkin\Instrumentation\Http\Client;
+namespace Zipkin\Instrumentation\Http\Client\Psr18;
 
 use Zipkin\Tracer;
 use Zipkin\SpanCustomizerShield;
 use Zipkin\Propagation\TraceContext;
 use Zipkin\Kind;
+use Zipkin\Instrumentation\Http\Client\Psr18\Propagation\RequestHeaders;
+use Zipkin\Instrumentation\Http\Client\Parser;
+use Zipkin\Instrumentation\Http\Client\HttpClientTracing;
 use Throwable;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\RequestInterface;
@@ -36,15 +39,13 @@ final class Client implements ClientInterface
     private $parser;
 
     /**
-     * @var (callable(RequestInterface):?bool)|null
+     * @var (callable(Request):?bool)|null
      */
     private $requestSampler;
 
-    public function __construct(
-        ClientInterface $delegate,
-        ClientTracing $tracing
-    ) {
-        $this->delegate = $delegate;
+    public function __construct(ClientInterface $client, HttpClientTracing $tracing)
+    {
+        $this->delegate = $client;
         $this->injector = $tracing->getTracing()->getPropagation()->getInjector(new RequestHeaders());
         $this->tracer = $tracing->getTracing()->getTracer();
         $this->parser = $tracing->getParser();
@@ -53,12 +54,13 @@ public function __construct(
 
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
+        $parsedRequest = new Request($request);
         if ($this->requestSampler === null) {
             $span = $this->tracer->nextSpan();
         } else {
             $span = $this->tracer->nextSpanWithSampler(
                 $this->requestSampler,
-                [$request]
+                [$parsedRequest]
             );
         }
 
@@ -76,13 +78,12 @@ public function sendRequest(RequestInterface $request): ResponseInterface
         // If span is NOOP it does not make sense to add customizations
         // to it like tags or annotations.
         $spanCustomizer = new SpanCustomizerShield($span);
-        $span->setName($this->parser->spanName($request));
-        $this->parser->request($request, $span->getContext(), $spanCustomizer);
+        $this->parser->request($parsedRequest, $span->getContext(), $spanCustomizer);
 
         try {
             $span->start();
             $response = $this->delegate->sendRequest($request);
-            $this->parser->response($response, $span->getContext(), $spanCustomizer);
+            $this->parser->response(new Response($response, $parsedRequest), $span->getContext(), $spanCustomizer);
             return $response;
         } catch (Throwable $e) {
             $span->setError($e);

src/Zipkin/Instrumentation/Http/Client/RequestHeaders.php → src/Zipkin/Instrumentation/Http/Client/Psr18/Propagation/RequestHeaders.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Zipkin\Instrumentation\Http\Client;
+namespace Zipkin\Instrumentation\Http\Client\Psr18\Propagation;
 
 use Zipkin\Propagation\RequestHeaders as BaseRequestHeaders;
 use Zipkin\Propagation\RemoteSetter;

src/Zipkin/Instrumentation/Http/Client/README.md → src/Zipkin/Instrumentation/Http/Client/Psr18/README.md

@@ -17,14 +17,14 @@ In this example we use Guzzle 7 but any HTTP client supporting PSR18 clients wil
 ```php
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Request;
-use Zipkin\Instrumentation\Http\Client\Client as ZipkinClient;
-use Zipkin\Instrumentation\Http\Client\ClientTracing;
+use Zipkin\Instrumentation\Http\Client\HttpClientTracing;
+use Zipkin\Instrumentation\Http\Client\Psr\Client as ZipkinClient;
 
 $tracing = TracingBuilder::create()
             ->havingLocalServiceName('my_service')
             ->build();
 
-$httpClientTracing = new ClientTracing($tracing);
+$httpClientTracing = new HttpClientTracing($tracing);
 ...
 
 $httpClient = new ZipkinClient(new Client, $httpClientTracing);

src/Zipkin/Instrumentation/Http/Client/Psr18/Request.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zipkin\Instrumentation\Http\Client\Psr18;
+
+use Zipkin\Instrumentation\Http\Client\Request as ClientRequest;
+use Psr\Http\Message\RequestInterface;
+
+final class Request extends ClientRequest
+{
+    /**
+     * @var RequestInterface
+     */
+    private $delegate;
+
+    public function __construct(RequestInterface $delegate)
+    {
+        $this->delegate = $delegate;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getMethod(): string
+    {
+        return $this->delegate->getMethod();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPath(): ?string
+    {
+        return $this->delegate->getUri()->getPath();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUrl(): string
+    {
+        return $this->delegate->getUri()->__toString();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getHeader(string $name): ?string
+    {
+        return $this->delegate->getHeaderLine($name) ?: null;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return RequestInterface
+     */
+    public function unwrap()
+    {
+        return $this->delegate;
+    }
+}