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

Author: tidal

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": {

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;

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;

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',

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();

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));
 

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',

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();

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
     )

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();