Move and refactor clock components (#633)

* Move Clock classes to SDK\Common\Time namespace * Move conversion methods to Util class * Implement StopWatch * Implement ClockFactory * Fix StopwatchInterface * Finalize ClockFactory * Implement StopWatchFactory * Deprecate AbstractClock * Add BC alias * Add initial start time to StopWatch * Unify and optimize SystemClock methods * Use ClockFactory in Span * Use ClockFactory in BatchSpanProcessor * Use ClockInterface in BatchSpanProcessorTest * Use ClockFactory in SpanData * Use ClockFactory in examples * Add millisToNanos Util method * Use StopWatch in BatchSpanProcessor * Make Phan happy * Make Psalm happy * Make PHPUnit happy * Remove sllh/composer-versions-check from allowed composer plugins * Use correct assertion * Use correct assertion * Assert difference
open-telemetry · Mar 25, 2022 · 8e1e912 · 8e1e912
1 parent 2b72c92
commit 8e1e912
Show file tree

Hide file tree

Showing 40 changed files with 902 additions and 183 deletions.
diff --git a/composer.json b/composer.json
@@ -55,7 +55,10 @@
             "Jaeger\\Thrift\\": "thrift/jaeger/"
         },
         "files": [
-            "src/Context/fiber/initialize_fiber_handler.php"
+            "src/Context/fiber/initialize_fiber_handler.php",
+            "src/SDK/Common/Time/ClockInterface.php",
+            "src/SDK/Common/Time/AbstractClock.php",
+            "src/SDK/Common/Time/SystemClock.php"
         ]
     },
     "autoload-dev": {

diff --git a/docs/laravel-integration.md b/docs/laravel-integration.md
@@ -97,7 +97,6 @@ $kernel->terminate($request, $response);
  ```php
 use OpenTelemetry\Contrib\Jaeger\Exporter as JaegerExporter;
 use OpenTelemetry\Contrib\Zipkin\Exporter as ZipkinExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;

diff --git a/docs/symfony-integration.md b/docs/symfony-integration.md
@@ -113,7 +113,6 @@ To use open-telemetry specific classes we have to import them at the top of our
 use App\Kernel;
 use OpenTelemetry\Contrib\Jaeger\Exporter as JaegerExporter;
 use OpenTelemetry\Contrib\Zipkin\Exporter as ZipkinExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;
 use OpenTelemetry\SDK\Trace\SpanProcessor\BatchSpanProcessor;

diff --git a/examples/AlwaysOffTraceExample.php b/examples/AlwaysOffTraceExample.php
@@ -5,8 +5,8 @@
 
 use OpenTelemetry\API\Trace as API;
 use OpenTelemetry\Context\Context;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOffSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;
 use OpenTelemetry\SDK\Trace\TracerProvider;
@@ -28,7 +28,7 @@
     $span->setAttribute('remote_ip', '1.2.3.4');
     $span->setAttribute('country', 'USA');
 
-    $timestamp = AbstractClock::getDefault()->timestamp();
+    $timestamp = ClockFactory::getDefault()->timestamp();
     $span->addEvent('found_login', new Attributes([
         'id' => 12345,
         'username' => 'otuser',

diff --git a/examples/AlwaysOnNewrelicExample.php b/examples/AlwaysOnNewrelicExample.php
@@ -8,8 +8,8 @@
 use OpenTelemetry\API\Trace as API;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Contrib\Newrelic\Exporter as NewrelicExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;
 use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
@@ -67,7 +67,7 @@
 
     for ($i = 0; $i < 5; $i++) {
         // start a span, register some events
-        $timestamp = AbstractClock::getDefault()->timestamp();
+        $timestamp = ClockFactory::getDefault()->now();
         $span = $tracer->startAndActivateSpan('session.generate.span.' . microtime(true));
 
         $spanParent = $span->getParentContext();

diff --git a/examples/AlwaysOnOTLPGrpcExample1.php b/examples/AlwaysOnOTLPGrpcExample1.php
@@ -6,8 +6,8 @@
 use OpenTelemetry\API\Trace as API;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Contrib\OtlpGrpc\Exporter as OTLPExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;
 use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
@@ -31,7 +31,7 @@
 
     for ($i = 0; $i < 5; $i++) {
         // start a span, register some events
-        $timestamp = AbstractClock::getDefault()->timestamp();
+        $timestamp = ClockFactory::getDefault()->now();
         $span = $tracer->startAndActivateSpan('session.generate.span' . microtime(true));
         //startAndActivateSpan('session.generate.span.' . microtime(true));
 

diff --git a/examples/AlwaysOnOTLPGrpcExample2.php b/examples/AlwaysOnOTLPGrpcExample2.php
@@ -6,8 +6,8 @@
 use OpenTelemetry\API\Trace as API;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Contrib\OtlpGrpc\Exporter as OTLPExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;
 use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
@@ -35,7 +35,7 @@
 
     $rootSpan->setAttribute('remote_ip', '1.2.3.4')
         ->setAttribute('country', 'USA');
-    $timestamp = AbstractClock::getDefault()->timestamp();
+    $timestamp = ClockFactory::getDefault()->now();
     $rootSpan->addEvent('found_login', new Attributes([
         'id' => 1,
         'username' => 'otuser',

diff --git a/examples/AlwaysOnZipkinToNewrelicExample.php b/examples/AlwaysOnZipkinToNewrelicExample.php
@@ -8,8 +8,8 @@
 use OpenTelemetry\API\Trace as API;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Contrib\ZipkinToNewrelic\Exporter as ZipkinToNewrelicExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Time\ClockFactory;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SamplingResult;
 use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
@@ -67,7 +67,7 @@
 
     for ($i = 0; $i < 5; $i++) {
         // start a span, register some events
-        $timestamp = AbstractClock::getDefault()->timestamp();
+        $timestamp = ClockFactory::getDefault()->now();
         $span = $tracer->startAndActivateSpan('session.generate.span.' . microtime(true));
 
         $spanParent = $span->getParentContext();

diff --git a/examples/BatchExporting.php b/examples/BatchExporting.php
@@ -15,7 +15,7 @@
 $tracerProvider =  new TracerProvider(
     new BatchSpanProcessor(
         new ConsoleSpanExporter(),
-        \OpenTelemetry\SDK\SystemClock::getDefault(),
+        \OpenTelemetry\SDK\Common\Time\SystemClock::getDefault(),
         2048, //max spans to queue before sending to exporter
         $delayMillis, //batch delay milliseconds
     )

diff --git a/examples/LoggingOfSpanData.php b/examples/LoggingOfSpanData.php
@@ -17,7 +17,6 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\HttpFactory;
 use OpenTelemetry\Contrib\Jaeger\Exporter as JaegerExporter;
-use OpenTelemetry\SDK\AbstractClock;
 use OpenTelemetry\SDK\Logs\SimplePsrFileLogger;
 use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
 use OpenTelemetry\SDK\Trace\SpanExporter\LoggerDecorator;
@@ -59,7 +58,7 @@
  * Create the Tracer
  */
 $tracerProvider = new TracerProvider(
-    new BatchSpanProcessor($decorator, AbstractClock::getDefault()),
+    new BatchSpanProcessor($decorator),
     new AlwaysOnSampler()
 );
 $tracer = $tracerProvider->getTracer();

diff --git a/src/Contrib/Jaeger/SpanConverter.php b/src/Contrib/Jaeger/SpanConverter.php
@@ -12,7 +12,7 @@
 use Jaeger\Thrift\TagType;
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\StatusCode;
-use OpenTelemetry\SDK\AbstractClock;
+use OpenTelemetry\SDK\Common\Time\Util as TimeUtil;
 use OpenTelemetry\SDK\Trace\EventInterface;
 use OpenTelemetry\SDK\Trace\LinkInterface;
 use OpenTelemetry\SDK\Trace\SpanConverterInterface;
@@ -69,8 +69,8 @@ private function convertSpan(SpanDataInterface $span): JTSpan
             'parentSpanId' => $parentSpanId,
         ] = self::convertOtelToJaegerIds($span);
 
-        $startTime = AbstractClock::nanosToMicro($span->getStartEpochNanos());
-        $duration = AbstractClock::nanosToMicro($span->getEndEpochNanos() - $span->getStartEpochNanos());
+        $startTime = TimeUtil::nanosToMicros($span->getStartEpochNanos());
+        $duration = TimeUtil::nanosToMicros($span->getEndEpochNanos() - $span->getStartEpochNanos());
 
         $tags = self::convertOtelSpanDataToJaegerTags($span);
 
@@ -292,7 +292,7 @@ function ($event) {
 
     private static function convertSingleOtelEventToJaegerLog(EventInterface $event): Log
     {
-        $timestamp = AbstractClock::nanosToMicro($event->getEpochNanos());
+        $timestamp = TimeUtil::nanosToMicros($event->getEpochNanos());
 
         $eventValue = $event->getAttributes()->get(self::EVENT_ATTRIBUTE_KEY_NAMED_EVENT) ?? $event->getName();
         $attributes = $event->getAttributes()->toArray();

diff --git a/src/Contrib/Newrelic/SpanConverter.php b/src/Contrib/Newrelic/SpanConverter.php
@@ -4,7 +4,7 @@
 
 namespace OpenTelemetry\Contrib\Newrelic;
 
-use OpenTelemetry\SDK\AbstractClock;
+use OpenTelemetry\SDK\Common\Time\Util as TimeUtil;
 use OpenTelemetry\SDK\Trace\SpanConverterInterface;
 use OpenTelemetry\SDK\Trace\SpanDataInterface;
 
@@ -37,8 +37,8 @@ private function convertSpan(SpanDataInterface $span): array
     {
         $spanParent = $span->getParentContext();
 
-        $startTimestamp = AbstractClock::nanosToMilli($span->getStartEpochNanos());
-        $endTimestamp = AbstractClock::nanosToMilli($span->getEndEpochNanos());
+        $startTimestamp = TimeUtil::nanosToMillis($span->getStartEpochNanos());
+        $endTimestamp = TimeUtil::nanosToMillis($span->getEndEpochNanos());
 
         $row = [
             'id' => $span->getSpanId(),

diff --git a/src/Contrib/Zipkin/SpanConverter.php b/src/Contrib/Zipkin/SpanConverter.php
@@ -8,7 +8,7 @@
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\StatusCode;
 use OpenTelemetry\Contrib\Zipkin\SpanKind as ZipkinSpanKind;
-use OpenTelemetry\SDK\AbstractClock;
+use OpenTelemetry\SDK\Common\Time\Util as TimeUtil;
 use OpenTelemetry\SDK\Trace\EventInterface;
 use OpenTelemetry\SDK\Trace\SpanConverterInterface;
 use OpenTelemetry\SDK\Trace\SpanDataInterface;
@@ -75,8 +75,8 @@ private function convertSpan(SpanDataInterface $span): array
     {
         $spanParent = $span->getParentContext();
 
-        $startTimestamp = AbstractClock::nanosToMicro($span->getStartEpochNanos());
-        $endTimestamp = AbstractClock::nanosToMicro($span->getEndEpochNanos());
+        $startTimestamp = TimeUtil::nanosToMicros($span->getStartEpochNanos());
+        $endTimestamp = TimeUtil::nanosToMicros($span->getEndEpochNanos());
 
         $row = [
             'id' => $span->getSpanId(),
@@ -167,7 +167,7 @@ private static function toAnnotation(EventInterface $event): array
         $value = ($attributesAsJson !== null) ? sprintf('"%s": %s', $eventName, $attributesAsJson) : sprintf('"%s"', $eventName);
 
         $annotation = [
-            'timestamp' => AbstractClock::nanosToMicro($event->getEpochNanos()),
+            'timestamp' => TimeUtil::nanosToMicros($event->getEpochNanos()),
             'value' => $value,
         ];
 

diff --git a/src/Contrib/ZipkinToNewrelic/SpanConverter.php b/src/Contrib/ZipkinToNewrelic/SpanConverter.php
@@ -5,7 +5,7 @@
 namespace OpenTelemetry\Contrib\ZipkinToNewrelic;
 
 use function max;
-use OpenTelemetry\SDK\AbstractClock;
+use OpenTelemetry\SDK\Common\Time\Util as TimeUtil;
 use OpenTelemetry\SDK\Trace\SpanConverterInterface;
 use OpenTelemetry\SDK\Trace\SpanDataInterface;
 
@@ -56,8 +56,8 @@ private function convertSpan(SpanDataInterface $span): array
     {
         $spanParent = $span->getParentContext();
 
-        $startTimestamp = AbstractClock::nanosToMicro($span->getStartEpochNanos());
-        $endTimestamp = AbstractClock::nanosToMicro($span->getEndEpochNanos());
+        $startTimestamp = TimeUtil::nanosToMicros($span->getStartEpochNanos());
+        $endTimestamp = TimeUtil::nanosToMicros($span->getEndEpochNanos());
 
         $row = [
             'id' => $span->getSpanId(),
@@ -88,7 +88,7 @@ private function convertSpan(SpanDataInterface $span): array
                 $row['annotations'] = [];
             }
             $row['annotations'][] = [
-                'timestamp' => AbstractClock::nanosToMicro($event->getEpochNanos()),
+                'timestamp' => TimeUtil::nanosToMicros($event->getEpochNanos()),
                 'value' => $event->getName(),
             ];
         }

diff --git a/src/SDK/ClockInterface.php b/src/SDK/ClockInterface.php
diff --git a/src/SDK/AbstractClock.php → src/SDK/Common/Time/AbstractClock.php b/src/SDK/AbstractClock.php → src/SDK/Common/Time/AbstractClock.php
@@ -2,17 +2,19 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\SDK;
-
-use function intdiv;
+namespace OpenTelemetry\SDK\Common\Time;
 
+/**
+ * @deprecated
+ * Use {@see \OpenTelemetry\SDK\Common\Time\ClockFactory} and {@see \OpenTelemetry\SDK\Common\Time\Util} instead.
+ */
 abstract class AbstractClock implements ClockInterface
 {
     private static ?ClockInterface $testClock;
 
     public static function getDefault(): ClockInterface
     {
-        return self::$testClock ?? SystemClock::getInstance();
+        return self::$testClock ?? SystemClock::create();
     }
 
     /**
@@ -42,3 +44,9 @@ public static function secondsToNanos(int $seconds): int
         return $seconds * self::NANOS_PER_SECOND;
     }
 }
+
+/**
+ * BC class alias
+ * @todo: remove in future release. Also in composer.json autoload/files.
+ */
+class_alias(AbstractClock::class, 'OpenTelemetry\SDK\AbstractClock');
diff --git a/src/SDK/Common/Time/ClockFactory.php b/src/SDK/Common/Time/ClockFactory.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Time;
+
+final class ClockFactory implements ClockFactoryInterface
+{
+    private static ?ClockInterface $default;
+
+    public static function create(): self
+    {
+        return new self();
+    }
+
+    public function build(): ClockInterface
+    {
+        return new SystemClock();
+    }
+
+    public static function getDefault(): ClockInterface
+    {
+        return self::$default ?? self::$default = self::create()->build();
+    }
+
+    public static function setDefault(?ClockInterface $clock): void
+    {
+        self::$default = $clock;
+    }
+}
diff --git a/src/SDK/Common/Time/ClockFactoryInterface.php b/src/SDK/Common/Time/ClockFactoryInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Time;
+
+interface ClockFactoryInterface
+{
+    public static function create(): self;
+
+    public function build(): ClockInterface;
+
+    public static function getDefault(): ClockInterface;
+
+    public static function setDefault(?ClockInterface $clock): void;
+}
diff --git a/src/SDK/Common/Time/ClockInterface.php b/src/SDK/Common/Time/ClockInterface.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Common\Time;
+
+interface ClockInterface
+{
+    public const MILLIS_PER_SECOND = 1_000;
+    public const MICROS_PER_SECOND = 1_000_000;
+    public const NANOS_PER_SECOND = 1_000_000_000;
+    public const NANOS_PER_MILLISECOND = 1_000_000;
+    public const NANOS_PER_MICROSECOND = 1_000;
+
+    /**
+     * Returns the current epoch wall-clock timestamp in nanoseconds
+     */
+    public function now(): int;
+
+    /**
+     * @deprecated
+     */
+    public function nanoTime(): int;
+}
+
+/**
+ * BC class alias
+ * @todo: remove in future release. Also in composer.json autoload/files.
+ */
+class_alias(ClockInterface::class, 'OpenTelemetry\SDK\ClockInterface');