Added default config of noop driver for hyperf/opentracing. (#6550)

hyperf · Feb 24, 2024 · 149f64a · 149f64a
1 parent 9168a08
commit 149f64a
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 0 deletions.
diff --git a/publish/opentracing.php b/publish/opentracing.php
@@ -14,6 +14,7 @@
 use function Hyperf\Support\env;
 
 return [
+    // To disable hyperf/opentracing temporarily, set default driver to noop.
     'default' => env('TRACER_DRIVER', 'zipkin'),
     'enable' => [
         'coroutine' => env('TRACER_ENABLE_COROUTINE', false),
@@ -88,6 +89,9 @@
                 ],
             ],
         ],
+        'noop' => [
+            'driver' => Hyperf\Tracer\Adapter\NoOpTracerFactory::class,
+        ],
     ],
     'tags' => [
         'http_client' => [

diff --git a/src/Adapter/NoOpTracerFactory.php b/src/Adapter/NoOpTracerFactory.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Tracer\Adapter;
+
+use Hyperf\Tracer\Contract\NamedFactoryInterface;
+use OpenTracing\NoopTracer;
+use OpenTracing\Tracer;
+
+class NoOpTracerFactory implements NamedFactoryInterface
+{
+    public function make(string $name): Tracer
+    {
+        return new NoopTracer();
+    }
+}
diff --git a/tests/TracerFactoryTest.php b/tests/TracerFactoryTest.php
@@ -87,6 +87,9 @@ public function testZipkinFactory()
                         'options' => [
                         ],
                     ],
+                    'noop' => [
+                        'driver' => \Hyperf\Tracer\Adapter\NoOpTracerFactory::class,
+                    ],
                 ],
             ],
         ]);
@@ -123,6 +126,9 @@ public function testJaegerFactory()
                         'options' => [
                         ],
                     ],
+                    'noop' => [
+                        'driver' => \Hyperf\Tracer\Adapter\NoOpTracerFactory::class,
+                    ],
                 ],
             ],
         ]);
@@ -132,6 +138,42 @@ public function testJaegerFactory()
         $this->assertInstanceOf(\Jaeger\Tracer::class, $factory($container));
     }
 
+    public function testNoOpFactory()
+    {
+        $config = new Config([
+            'opentracing' => [
+                'default' => 'noop',
+                'enable' => [
+                ],
+                'tracer' => [
+                    'zipkin' => [
+                        'driver' => \Hyperf\Tracer\Adapter\ZipkinTracerFactory::class,
+                        'app' => [
+                            'name' => 'skeleton',
+                            // Hyperf will detect the system info automatically as the value if ipv4, ipv6, port is null
+                            'ipv4' => '127.0.0.1',
+                            'ipv6' => null,
+                            'port' => 9501,
+                        ],
+                        'options' => [
+                        ],
+                        'sampler' => BinarySampler::createAsAlwaysSample(),
+                    ],
+                    'jaeger' => [
+                        'driver' => \Hyperf\Tracer\Adapter\JaegerTracerFactory::class,
+                        'name' => 'skeleton',
+                        'options' => [
+                        ],
+                    ],
+                ],
+            ],
+        ]);
+        $container = $this->getContainer($config);
+        $factory = new TracerFactory();
+
+        $this->assertInstanceOf(\OpenTracing\NoopTracer::class, $factory($container));
+    }
+
     protected function getContainer($config)
     {
         $container = Mockery::mock(Container::class);