Add ReadableSpan/ReadWriteSpan interfaces (#403)

* Add ReadableSpan interface * Add ReadWriteSpan interface Remove reading methods from API\Span interface. * Fix code style
open-telemetry · Aug 27, 2021 · 04f84d7 · 04f84d7
1 parent e5e8b74
commit 04f84d7
Show file tree

Hide file tree

Showing 32 changed files with 230 additions and 104 deletions.
diff --git a/api/Trace/Span.php b/api/Trace/Span.php
@@ -8,33 +8,6 @@
 
 interface Span extends SpanStatus, SpanKind
 {
-    public function getSpanName(): string;
-    public function getContext(): SpanContext;
-    public function getParent(): ?SpanContext;
-
-    /**
-     * Returns Epoch timestamp value (RealtimeClock) when the Span was created
-     * @return int
-     */
-    public function getStartEpochTimestamp(): int;
-
-    /**
-     * Returns system time clock value (MonotonicClock) when the Span was created
-     * @return int
-     */
-    public function getStart(): int;
-
-    /**
-     * Returns system time clock value (MonotonicClock) when the Span was stopped
-     * @return int|null
-     */
-    public function getEnd(): ?int;
-
-    public function getAttributes(): Attributes;
-    public function getLinks(): Links;
-    public function getEvents(): Events;
-    public function getStatus(): SpanStatus;
-
     /**
      * Attributes SHOULD preserve the order in which they're set. Setting an attribute with the same key as an existing
      * attribute SHOULD overwrite the existing attribute's value.
@@ -90,6 +63,4 @@ public function setSpanStatus(string $code, ?string $description = null): Span;
     public function end(int $timestamp = null): Span;
 
     public function isRecording(): bool;
-
-    public function isSampled(): bool;
 }
diff --git a/api/Trace/SpanOptions.php b/api/Trace/SpanOptions.php
@@ -4,6 +4,8 @@
 
 namespace OpenTelemetry\Trace;
 
+use OpenTelemetry\Context\Context;
+
 /**
  * The SpanOptions implementation is intended to be tightly coupled with the Span and Tracer implementations.
  * Hopefully the Span object can implement SpanOptions so that the toSpan() call is almost a no-op, but prevents
@@ -14,8 +16,7 @@ interface SpanOptions
     public function setSpanName(string $name): SpanOptions;
     /** should default to INTERNAL if not called */
     public function setSpanKind(int $spanKind): SpanOptions;
-    public function setParentContext(SpanContext $span): SpanOptions;
-    public function setParentSpan(Span $span): SpanOptions;
+    public function setParent(Context $parentContext): SpanOptions;
     public function addAttributes(Attributes $attributes): SpanOptions;
     public function addLinks(Links $links): SpanOptions;
 

diff --git a/contrib/Newrelic/Exporter.php b/contrib/Newrelic/Exporter.php
@@ -9,7 +9,6 @@
 use GuzzleHttp\Psr7\HttpFactory;
 use InvalidArgumentException;
 use OpenTelemetry\Sdk\Trace;
-use OpenTelemetry\Trace as API;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Client\NetworkExceptionInterface;
@@ -64,7 +63,7 @@ class Exporter implements Trace\Exporter
      * @var RequestFactoryInterface
      */
     private $requestFactory;
-    
+
     /**
      * @var StreamFactoryInterface
      */
@@ -108,7 +107,7 @@ public function __construct(
     /**
      * Exports the provided Span data via the Newrelic protocol
      *
-     * @param iterable<API\Span> $spans Array of Spans
+     * @param iterable<Trace\ReadableSpan> $spans Array of Spans
      * @return int return code, defined on the Exporter interface
      */
     public function export(iterable $spans): int

diff --git a/contrib/Newrelic/SpanConverter.php b/contrib/Newrelic/SpanConverter.php
@@ -4,7 +4,7 @@
 
 namespace OpenTelemetry\Contrib\Newrelic;
 
-use OpenTelemetry\Trace\Span;
+use OpenTelemetry\Sdk\Trace\ReadableSpan;
 
 class SpanConverter
 {
@@ -21,7 +21,7 @@ public function __construct(string $serviceName)
         $this->serviceName = $serviceName;
     }
 
-    public function convert(Span $span)
+    public function convert(ReadableSpan $span)
     {
         $spanParent = $span->getParent();
         $row = [

diff --git a/contrib/Otlp/Exporter.php b/contrib/Otlp/Exporter.php
@@ -9,7 +9,6 @@
 use OpenTelemetry\Contrib\OtlpGrpc\Exporter as OtlpGrpcExporter;
 use OpenTelemetry\Contrib\OtlpHttp\Exporter as OtlpHttpExporter;
 use OpenTelemetry\Sdk\Trace;
-use OpenTelemetry\Trace as API;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Client\NetworkExceptionInterface;
@@ -72,7 +71,7 @@ class Exporter implements Trace\Exporter
      * @var RequestFactoryInterface
      */
     private $requestFactory;
-    
+
     /**
      * @var StreamFactoryInterface
      */
@@ -108,7 +107,7 @@ public function __construct(
     /**
      * Exports the provided Span data via the OTLP protocol
      *
-     * @param iterable<API\Span> $spans Array of Spans
+     * @param iterable<Trace\ReadableSpan> $spans Array of Spans
      * @return int return code, defined on the Exporter interface
      */
     public function export(iterable $spans): int

diff --git a/contrib/Otlp/SpanConverter.php b/contrib/Otlp/SpanConverter.php
@@ -4,7 +4,7 @@
 
 namespace OpenTelemetry\Contrib\Otlp;
 
-use OpenTelemetry\Trace\Span;
+use OpenTelemetry\Sdk\Trace\ReadableSpan;
 
 class SpanConverter
 {
@@ -40,7 +40,7 @@ private function sanitiseTagValue($value)
         return (string) $value;
     }
 
-    public function convert(Span $span)
+    public function convert(ReadableSpan $span)
     {
         $spanParent = $span->getParent();
         $row = [

diff --git a/contrib/OtlpGrpc/Exporter.php b/contrib/OtlpGrpc/Exporter.php
@@ -9,7 +9,6 @@
 use Opentelemetry\Proto\Collector\Trace\V1\ExportTraceServiceRequest;
 use Opentelemetry\Proto\Collector\Trace\V1\TraceServiceClient;
 use OpenTelemetry\Sdk\Trace;
-use OpenTelemetry\Trace as API;
 
 class Exporter implements Trace\Exporter
 {
@@ -53,7 +52,7 @@ class Exporter implements Trace\Exporter
     private $spanConverter;
 
     private $metadata;
-    
+
     /**
     * @var bool
     */
@@ -126,15 +125,15 @@ public function getClientOptions(): array
     /**
      * Exports the provided Span data via the OTLP protocol
      *
-     * @param iterable<API\Span> $spans Array of Spans
+     * @param iterable<Trace\ReadableSpan> $spans Array of Spans
      * @return int return code, defined on the Exporter interface
      */
     public function export(iterable $spans): int
     {
         if (!$this->running) {
             return Exporter::FAILED_NOT_RETRYABLE;
         }
-        
+
         if (empty($spans)) {
             return Trace\Exporter::SUCCESS;
         }

diff --git a/contrib/OtlpGrpc/SpanConverter.php b/contrib/OtlpGrpc/SpanConverter.php
@@ -16,7 +16,7 @@
 use Opentelemetry\Proto\Trace\V1\Span\SpanKind;
 use Opentelemetry\Proto\Trace\V1\Status;
 use Opentelemetry\Proto\Trace\V1\Status\StatusCode;
-use OpenTelemetry\Sdk\Trace\Span;
+use OpenTelemetry\Sdk\Trace\ReadableSpan;
 use OpenTelemetry\Sdk\Trace\SpanStatus;
 
 class SpanConverter
@@ -78,7 +78,7 @@ public function as_otlp_span_kind($kind): int
         return SpanKind::SPAN_KIND_UNSPECIFIED;
     }
 
-    public function as_otlp_span(Span $span): CollectorSpan
+    public function as_otlp_span(ReadableSpan $span): CollectorSpan
     {
         $end_timestamp = ($span->getStartEpochTimestamp() + $span->getDuration());
 

diff --git a/contrib/OtlpHttp/Exporter.php b/contrib/OtlpHttp/Exporter.php
@@ -9,7 +9,6 @@
 use InvalidArgumentException;
 use Opentelemetry\Proto\Collector\Trace\V1\ExportTraceServiceRequest;
 use OpenTelemetry\Sdk\Trace;
-use OpenTelemetry\Trace as API;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Client\NetworkExceptionInterface;
@@ -124,7 +123,7 @@ public function __construct(
     /**
      * Exports the provided Span data via the OTLP protocol
      *
-     * @param iterable<API\Span> $spans Array of Spans
+     * @param iterable<Trace\ReadableSpan> $spans Array of Spans
      * @return int return code, defined on the Exporter interface
      */
     public function export(iterable $spans): int

diff --git a/contrib/OtlpHttp/SpanConverter.php b/contrib/OtlpHttp/SpanConverter.php
@@ -16,7 +16,7 @@
 use Opentelemetry\Proto\Trace\V1\Span\SpanKind;
 use Opentelemetry\Proto\Trace\V1\Status;
 use Opentelemetry\Proto\Trace\V1\Status\StatusCode;
-use OpenTelemetry\Sdk\Trace\Span;
+use OpenTelemetry\Sdk\Trace\ReadableSpan;
 use OpenTelemetry\Sdk\Trace\SpanStatus;
 
 class SpanConverter
@@ -76,7 +76,7 @@ public function as_otlp_span_kind($kind): int
         return SpanKind::SPAN_KIND_UNSPECIFIED;
     }
 
-    public function as_otlp_span(Span $span): CollectorSpan
+    public function as_otlp_span(ReadableSpan $span): CollectorSpan
     {
         $end_timestamp = ($span->getStartEpochTimestamp() + $span->getDuration());
 

diff --git a/contrib/Zipkin/Exporter.php b/contrib/Zipkin/Exporter.php
@@ -8,7 +8,6 @@
 use GuzzleHttp\Psr7\HttpFactory;
 use InvalidArgumentException;
 use OpenTelemetry\Sdk\Trace;
-use OpenTelemetry\Trace as API;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Client\NetworkExceptionInterface;
@@ -41,9 +40,9 @@ class Exporter implements Trace\Exporter
      * @var ClientInterface
      */
     private $client;
-    
+
     private $requestFactory;
-    
+
     private $streamFactory;
 
     public function __construct(
@@ -79,7 +78,7 @@ public function __construct(
     /**
      * Exports the provided Span data via the Zipkin protocol
      *
-     * @param iterable<API\Span> $spans Array of Spans
+     * @param iterable<Trace\ReadableSpan> $spans Array of Spans
      * @return int return code, defined on the Exporter interface
      */
     public function export(iterable $spans): int
@@ -103,7 +102,7 @@ public function export(iterable $spans): int
                 ->createRequest('POST', $this->endpointUrl)
                 ->withBody($body)
                 ->withHeader('content-type', 'application/json');
-            
+
             $response = $this->client->sendRequest($request);
         } catch (RequestExceptionInterface $e) {
             return Trace\Exporter::FAILED_NOT_RETRYABLE;

diff --git a/contrib/Zipkin/SpanConverter.php b/contrib/Zipkin/SpanConverter.php
@@ -4,7 +4,7 @@
 
 namespace OpenTelemetry\Contrib\Zipkin;
 
-use OpenTelemetry\Trace\Span;
+use OpenTelemetry\Sdk\Trace\ReadableSpan;
 
 class SpanConverter
 {
@@ -42,7 +42,7 @@ private function sanitiseTagValue($value)
         return (string) $value;
     }
 
-    public function convert(Span $span)
+    public function convert(ReadableSpan $span)
     {
         $spanParent = $span->getParent();
         $row = [

diff --git a/contrib/ZipkinToNewrelic/Exporter.php b/contrib/ZipkinToNewrelic/Exporter.php
@@ -9,7 +9,6 @@
 use GuzzleHttp\Psr7\HttpFactory;
 use InvalidArgumentException;
 use OpenTelemetry\Sdk\Trace;
-use OpenTelemetry\Trace as API;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Client\NetworkExceptionInterface;
@@ -56,7 +55,7 @@ class Exporter implements Trace\Exporter
      * @var RequestFactoryInterface
      */
     private $requestFactory;
-    
+
     /**
      * @var StreamFactoryInterface
      */
@@ -101,7 +100,7 @@ public function __construct(
     /**
      * Exports the provided Span data via the Zipkin protocol
      *
-     * @param iterable<API\Span> $spans Array of Spans
+     * @param iterable<Trace\ReadableSpan> $spans Array of Spans
      * @return int return code, defined on the Exporter interface
      */
     public function export(iterable $spans): int

diff --git a/contrib/ZipkinToNewrelic/SpanConverter.php b/contrib/ZipkinToNewrelic/SpanConverter.php
@@ -4,7 +4,7 @@
 
 namespace OpenTelemetry\Contrib\ZipkinToNewrelic;
 
-use OpenTelemetry\Trace\Span;
+use OpenTelemetry\Sdk\Trace\ReadableSpan;
 
 class SpanConverter
 {
@@ -42,7 +42,7 @@ private function sanitiseTagValue($value)
         return (string) $value;
     }
 
-    public function convert(Span $span)
+    public function convert(ReadableSpan $span)
     {
         $spanParent = $span->getParent();
         $row = [

diff --git a/sdk/Trace/Exporter.php b/sdk/Trace/Exporter.php
@@ -4,8 +4,6 @@
 
 namespace OpenTelemetry\Sdk\Trace;
 
-use OpenTelemetry\Trace as API;
-
 /**
  * A simple Exporter interface
  *
@@ -22,7 +20,7 @@ interface Exporter
 
     /**
      * Export trace data (spans)
-     * @param iterable<API\Span> $spans Batch of spans to export
+     * @param iterable<ReadableSpan> $spans Batch of spans to export
      * @return int
      */
     public function export(iterable $spans): int;

diff --git a/sdk/Trace/NoopSpan.php b/sdk/Trace/NoopSpan.php
@@ -6,10 +6,12 @@
 
 use OpenTelemetry\Context\ContextKey;
 use OpenTelemetry\Context\ContextValueTrait;
+use OpenTelemetry\Sdk\InstrumentationLibrary;
+use OpenTelemetry\Sdk\Resource\ResourceInfo;
 use OpenTelemetry\Trace as API;
 use Throwable;
 
-class NoopSpan implements API\Span
+class NoopSpan implements API\Span, ReadableSpan
 {
     use ContextValueTrait;
 
@@ -192,4 +194,24 @@ protected static function getContextKey(): ContextKey
     {
         return SpanContextKey::instance();
     }
+
+    public function getSpanContext(): API\SpanContext
+    {
+        return $this->context;
+    }
+
+    public function getEndEpochTimestamp(): ?int
+    {
+        return null;
+    }
+
+    public function getResource(): ResourceInfo
+    {
+        return ResourceInfo::emptyResource();
+    }
+
+    public function getInstrumentationLibrary(): InstrumentationLibrary
+    {
+        return new InstrumentationLibrary('');
+    }
 }