Jaeger Thrift over Binary protocol implementation (UDP 6832 & Http 14268 support ) (#99)

Author: pekhota

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://github.com/jonahgeorge/jaeger-client-php/workflows/Test/badge.svg) [![PHP version][packagist-img]][packagist]
+![Build Status](https://github.com/jonahgeorge/jaeger-client-php/workflows/Test/badge.svg) [![PHP version][packagist-img]][packagist]
 
 # Jaeger Bindings for PHP OpenTracing API
 
@@ -93,6 +93,74 @@ Cache component is passed to `Jaeger\Config` trough its constructor.
     ]
 ],
 ```
+## Dispatch mode
+
+The library supports 3 ways of sending data to Jaeger Agent:  
+
+1. `Zipkin.thrift` over Compact protocol (socket - UDP) - default 
+2. `Jaeger.thrift` over Binary protocol (socket - UDP)
+2. `Jaeger.thrift` over Binary protocol (HTTP)
+
+If you want to enable "`Jaeger.thrift` over Binary protocol" one or other, than
+you need to set `dispatch_mode` config option or `JAEGER_DISPATCH_MODE` env
+variable.
+
+Allowed values for `dispatch_mode` are:
+- `jaeger_over_binary_udp`
+- `jaeger_over_binary_http`
+- `zipkin_over_compact_udp`
+
+There are 3 constants available, so it is better to use them:
+```php
+class Config
+{
+    const ZIPKIN_OVER_COMPACT_UDP   = "zipkin_over_compact_udp";
+    const JAEGER_OVER_BINARY_UDP    = "jaeger_over_binary_udp";
+    const JAEGER_OVER_BINARY_HTTP   = "jaeger_over_binary_http";
+    ...
+}
+```
+
+A possible config with custom `dispatch_mode` can look like this:
+```php
+// config.php
+
+use Jaeger\Config;
+
+return [
+    'sampler' => [
+        'type' => Jaeger\SAMPLER_TYPE_CONST,
+        'param' => true,
+    ],
+    'logging' => true,
+    "tags" => [
+        // process. prefix works only with JAEGER_OVER_HTTP, JAEGER_OVER_BINARY
+        // otherwise it will be shown as simple global tag
+        "process.process-tag-key-1" => "process-value-1", // all tags with `process.` prefix goes to process section
+        "process.process-tag-key-2" => "process-value-2", // all tags with `process.` prefix goes to process section
+        "global-tag-key-1" => "global-tag-value-1", // this tag will be appended to all spans
+        "global-tag-key-2" => "global-tag-value-2", // this tag will be appended to all spans
+    ],
+    "local_agent" => [
+        "reporting_host" => "localhost", 
+//        You can override port by setting local_agent.reporting_port value   
+        "reporting_port" => 6832
+    ],
+//     Different ways to send data to Jaeger. Config::ZIPKIN_OVER_COMPACT - default):
+    'dispatch_mode' => Config::JAEGER_OVER_BINARY_UDP,
+];
+```
+The full example you can see at `examples` directory.
+
+By default, for each `dispatch_mode` there is default `reporting_port` config value. Table with
+default values you can see below: 
+
+`dispatch_mode`          | default `reporting_port` 
+------------------------ | ---------------- 
+ZIPKIN_OVER_COMPACT_UDP  | 5775
+JAEGER_OVER_BINARY_UDP   | 6832
+JAEGER_OVER_BINARY_HTTP  | 14268
+
 
 ## Testing
 

examples/config.php

@@ -0,0 +1,26 @@
+<?php
+
+use Jaeger\Config;
+
+return [
+    'sampler' => [
+        'type' => Jaeger\SAMPLER_TYPE_CONST,
+        'param' => true,
+    ],
+    'logging' => true,
+    "tags" => [
+        // process. prefix works only with JAEGER_OVER_HTTP, JAEGER_OVER_BINARY
+        // otherwise it will be shown as simple global tag
+        "process.process-tag-key-1" => "process-value-1", // all tags with `process.` prefix goes to process section
+        "process.process-tag-key-2" => "process-value-2", // all tags with `process.` prefix goes to process section
+        "global-tag-key-1" => "global-tag-value-1", // this tag will be appended to all spans
+        "global-tag-key-2" => "global-tag-value-2", // this tag will be appended to all spans
+    ],
+    "local_agent" => [
+        "reporting_host" => "localhost",
+//        You can override port by setting local_agent.reporting_port value
+//        "reporting_port" => 6832
+    ],
+//     Different ways to send data to Jaeger. Config::ZIPKIN_OVER_COMPACT - default):
+    'dispatch_mode' => Config::JAEGER_OVER_BINARY_UDP,
+];

examples/jaeger.php

@@ -0,0 +1,51 @@
+<?php
+
+require_once __DIR__.'/../vendor/autoload.php';
+
+use Jaeger\Config;
+use OpenTracing\GlobalTracer;
+
+$config = new Config(
+    require_once __DIR__.'/config.php',
+    'your-app-name'
+);
+
+$config->initializeTracer();
+
+$tracer = GlobalTracer::get();
+
+$scope = $tracer->startActiveSpan('JaegerSpan', []);
+$scope->getSpan()->setTag("tag1", "value1");
+$scope->getSpan()->setTag("tag2", "value2");
+$scope->getSpan()->setTag("tag3", "value2");
+$scope->getSpan()->log([
+    "key1" => "value1",
+    "key2" => 2,
+    "key3" => true
+]);
+
+$scope->getSpan()->addBaggageItem("baggage-item1", "baggage-value1");
+$scope->getSpan()->addBaggageItem("baggage-item2", "baggage-value2");
+$scope->getSpan()->addBaggageItem("baggage-item3", "baggage-value3");
+
+    $nestedSpanScope = $tracer->startActiveSpan("Nested1");
+    $nestedSpanScope->getSpan()->setTag("tag1", "value1");
+    $nestedSpanScope->getSpan()->setTag("tag2", "value2");
+    $nestedSpanScope->getSpan()->setTag("tag3", "value2");
+    $nestedSpanScope->getSpan()->log([
+        "key1" => "value1",
+        "key2" => 2,
+        "key3" => true
+    ]);
+
+    $nestedSpanScope->getSpan()->addBaggageItem("baggage-item1", "baggage-value1");
+    $nestedSpanScope->getSpan()->addBaggageItem("baggage-item2", "baggage-value2");
+    $nestedSpanScope->getSpan()->addBaggageItem("baggage-item3", "baggage-value3");
+
+    sleep(1);
+
+    $nestedSpanScope->close();
+
+sleep(1);
+$scope->close();
+$tracer->flush();

src/Jaeger/AgentClient/HttpAgentClient.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Jaeger\AgentClient;
+
+class HttpAgentClient implements \Jaeger\Thrift\Agent\AgentIf
+{
+    protected $input_ = null;
+    protected $output_ = null;
+
+    protected $seqid_ = 0;
+
+    public function __construct($input, $output = null)
+    {
+        $this->input_ = $input;
+        $this->output_ = $output ? $output : $input;
+    }
+
+    public function emitZipkinBatch(array $spans)
+    {
+    }
+
+    public function emitBatch(\Jaeger\Thrift\Batch $batch)
+    {
+        $batch->write($this->output_);
+        $this->output_->getTransport()->flush();
+    }
+}

src/Jaeger/Config.php

@@ -5,25 +5,34 @@
 use Exception;
 use Jaeger\Reporter\CompositeReporter;
 use Jaeger\Reporter\LoggingReporter;
-use Jaeger\Reporter\RemoteReporter;
 use Jaeger\Reporter\ReporterInterface;
+use Jaeger\ReporterFactory\JaegerHttpReporterFactory;
+use Jaeger\ReporterFactory\JaegerReporterFactory;
+use Jaeger\ReporterFactory\ZipkinReporterFactory;
 use Jaeger\Sampler\ConstSampler;
 use Jaeger\Sampler\ProbabilisticSampler;
 use Jaeger\Sampler\RateLimitingSampler;
 use Jaeger\Sampler\SamplerInterface;
-use Jaeger\Sender\UdpSender;
-use Jaeger\Thrift\Agent\AgentClient;
 use Jaeger\Util\RateLimiter;
 use OpenTracing\GlobalTracer;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use Thrift\Exception\TTransportException;
-use Thrift\Protocol\TCompactProtocol;
-use Thrift\Transport\TBufferedTransport;
 
 class Config
 {
+    const ZIPKIN_OVER_COMPACT_UDP   = "zipkin_over_compact_udp";
+    const JAEGER_OVER_BINARY_UDP    = "jaeger_over_binary_udp";
+    const JAEGER_OVER_BINARY_HTTP   = "jaeger_over_binary_http";
+
+    /**
+     * @return string[]
+     */
+    public static function getAvailableDispatchModes()
+    {
+        return [self::ZIPKIN_OVER_COMPACT_UDP, self::JAEGER_OVER_BINARY_UDP, self::JAEGER_OVER_BINARY_HTTP];
+    }
+
     /**
      * @var array
      */
@@ -44,6 +53,14 @@ class Config
      */
     private $logger;
 
+    /**
+     * @return LoggerInterface
+     */
+    public function getLogger()
+    {
+        return $this->logger;
+    }
+
     /**
      * @var CacheItemPoolInterface
      */
@@ -67,6 +84,10 @@ public function __construct(
 
         $this->setConfigFromEnv();
 
+        if (empty($this->config["dispatch_mode"])) {
+            $this->config["dispatch_mode"] = self::ZIPKIN_OVER_COMPACT_UDP;
+        }
+
         $this->serviceName = $this->config['service_name'] ?? $serviceName;
         if ($this->serviceName === null) {
             throw new Exception('service_name required in the config or param.');
@@ -90,6 +111,7 @@ public function initializeTracer()
         $reporter = $this->getReporter();
         $sampler = $this->getSampler();
 
+
         $tracer = $this->createTracer($reporter, $sampler);
 
         $this->initializeGlobalTracer($tracer);
@@ -148,8 +170,25 @@ private function getLogging(): bool
      */
     private function getReporter(): ReporterInterface
     {
-        $channel = $this->getLocalAgentSender();
-        $reporter = new RemoteReporter($channel);
+        switch ($this->config["dispatch_mode"]) {
+            case self::JAEGER_OVER_BINARY_UDP:
+                $reporter = (new JaegerReporterFactory($this))->createReporter();
+                break;
+            case self::ZIPKIN_OVER_COMPACT_UDP:
+                $reporter = (new ZipkinReporterFactory($this))->createReporter();
+                break;
+            case self::JAEGER_OVER_BINARY_HTTP:
+                $reporter = (new JaegerHttpReporterFactory($this))->createReporter();
+                break;
+            default:
+                throw new \RuntimeException(
+                    sprintf(
+                        "Unsupported `dispatch_mode` value: %s. Allowed values are: %s",
+                        $this->config["dispatch_mode"],
+                        implode(", ", Config::getAvailableDispatchModes())
+                    )
+                );
+        }
 
         if ($this->getLogging()) {
             $reporter = new CompositeReporter($reporter, new LoggingReporter($this->logger));
@@ -193,56 +232,43 @@ private function getSampler(): SamplerInterface
         throw new Exception('Unknown sampler type ' . $samplerType);
     }
 
-    /**
-     * @return UdpSender
-     */
-    private function getLocalAgentSender(): UdpSender
-    {
-        $udp = new ThriftUdpTransport(
-            $this->getLocalAgentReportingHost(),
-            $this->getLocalAgentReportingPort(),
-            $this->logger
-        );
-
-        $transport = new TBufferedTransport($udp, $this->getMaxBufferLength(), $this->getMaxBufferLength());
-        try {
-            $transport->open();
-        } catch (TTransportException $e) {
-            $this->logger->warning($e->getMessage());
-        }
-
-        $protocol = new TCompactProtocol($transport);
-        $client = new AgentClient($protocol);
-
-        $this->logger->debug('Initializing Jaeger Tracer with UDP reporter');
-
-        return new UdpSender($client, $this->getMaxBufferLength(), $this->logger);
-    }
-
     /**
      * The UDP max buffer length.
      *
      * @return int
      */
-    private function getMaxBufferLength(): int
+    public function getMaxBufferLength(): int
     {
         return (int)($this->config['max_buffer_length'] ?? 64000);
     }
 
     /**
      * @return string
      */
-    private function getLocalAgentReportingHost(): string
+    public function getLocalAgentReportingHost(): string
     {
         return $this->getLocalAgentGroup()['reporting_host'] ?? DEFAULT_REPORTING_HOST;
     }
 
     /**
      * @return int
      */
-    private function getLocalAgentReportingPort(): int
+    public function getLocalAgentReportingPort(): int
     {
-        return (int)($this->getLocalAgentGroup()['reporting_port'] ?? DEFAULT_REPORTING_PORT);
+        $port = $this->getLocalAgentGroup()['reporting_port'] ?? null;
+        if (empty($this->getLocalAgentGroup()['reporting_port'])) {
+            switch ($this->config['dispatch_mode']) {
+                case self::JAEGER_OVER_BINARY_UDP:
+                    $port = DEFAULT_JAEGER_UDP_BINARY_REPORTING_PORT;
+                    break;
+                case self::JAEGER_OVER_BINARY_HTTP:
+                    $port = DEFAULT_JAEGER_HTTP_BINARY_REPORTING_PORT;
+                    break;
+                default:
+                    $port = DEFAULT_ZIPKIN_UDP_COMPACT_REPORTING_PORT;
+            }
+        }
+        return (int)$port;
     }
 
     /**
@@ -312,6 +338,10 @@ private function setConfigFromEnv()
             $this->config['tags'] = $_ENV['JAEGER_TAGS'];
         }
 
+        if (isset($_ENV['JAEGER_DISPATCH_MODE']) && !isset($this->config['dispatch_mode'])) {
+            $this->config['dispatch_mode'] = $_ENV['JAEGER_DISPATCH_MODE'];
+        }
+
         // reporting
         if (isset($_ENV['JAEGER_AGENT_HOST']) && !isset($this->config['local_agent']['reporting_host'])) {
             $this->config['local_agent']['reporting_host'] = $_ENV['JAEGER_AGENT_HOST'];

src/Jaeger/Constants.php

@@ -82,8 +82,13 @@
 
 const DEFAULT_REPORTING_HOST = 'localhost';
 
+/** @deprecated  */
 const DEFAULT_REPORTING_PORT = 5775;
 
+const DEFAULT_ZIPKIN_UDP_COMPACT_REPORTING_PORT = 5775;
+const DEFAULT_JAEGER_UDP_BINARY_REPORTING_PORT = 6832;
+const DEFAULT_JAEGER_HTTP_BINARY_REPORTING_PORT = 14268;
+
 const DEFAULT_SAMPLING_PORT = 5778;
 
 const LOCAL_AGENT_DEFAULT_ENABLED = true;