updating/removing phpdoc

open-telemetry · Feb 29, 2024 · d81115a · d81115a
1 parent be34c22
commit d81115a
Show file tree

Hide file tree

Showing 20 changed files with 71 additions and 202 deletions.
diff --git a/examples/traces/features/batch_exporting_with_self_diagnostics.php b/examples/traces/features/batch_exporting_with_self_diagnostics.php
@@ -5,7 +5,6 @@
 namespace OpenTelemetry\Example;
 
 use OpenTelemetry\API\Globals;
-use OpenTelemetry\SDK\Trace\TracerProviderInterface;
 
 putenv('OTEL_PHP_AUTOLOAD_ENABLED=true');
 putenv('OTEL_TRACES_EXPORTER=console');
@@ -14,12 +13,14 @@
 
 require __DIR__ . '/../../../vendor/autoload.php';
 
-$tracerProvider = Globals::tracerProvider();
+/**
+ * Demonstrates batch span processing which also emits metrics for the internal state
+ * of the processor (eg spans received, queue length)
+ */
 
-$tracer = $tracerProvider->getTracer('io.opentelemetry.contrib.php');
+echo 'Starting ConsoleSpanExporter with BatchSpanProcessor and metrics' . PHP_EOL;
 
-$span = $tracer->spanBuilder('root')->startSpan();
-$span->end();
+$tracer = Globals::tracerProvider()->getTracer('io.opentelemetry.contrib.php');
+$tracer->spanBuilder('root')->startSpan()->end();
 
-echo PHP_EOL;
-$tracerProvider instanceof TracerProviderInterface && $tracerProvider->shutdown();
+echo PHP_EOL . 'Example complete!  ' . PHP_EOL;
diff --git a/src/API/Trace/Propagation/TraceContextValidator.php b/src/API/Trace/Propagation/TraceContextValidator.php
@@ -11,9 +11,6 @@ class TraceContextValidator
     public const TRACE_FLAG_LENGTH = 2;
     public const TRACE_VERSION_REGEX = '/^(?!ff)[\da-f]{2}$/';
 
-    /**
-     * @return bool Returns a value that indicates whether a trace version is valid.
-     */
     public static function isValidTraceVersion(string $traceVersion): bool
     {
         return 1 === preg_match(self::TRACE_VERSION_REGEX, $traceVersion);

diff --git a/src/Contrib/Otlp/MetricExporter.php b/src/Contrib/Otlp/MetricExporter.php
@@ -25,13 +25,11 @@ final class MetricExporter implements PushMetricExporterInterface, AggregationTe
     private ProtobufSerializer $serializer;
 
     /**
-     * @param string|Temporality|null $temporality
-     *
      * @psalm-param TransportInterface<SUPPORTED_CONTENT_TYPES> $transport
      */
     public function __construct(
         private TransportInterface $transport,
-        private $temporality = null
+        private string|Temporality|null $temporality = null
     ) {
         if (!class_exists('\Google\Protobuf\Api')) {
             throw new RuntimeException('No protobuf implementation found (ext-protobuf or google/protobuf)');

diff --git a/src/Contrib/Otlp/ProtobufSerializer.php b/src/Contrib/Otlp/ProtobufSerializer.php
@@ -28,21 +28,17 @@
 /**
  * @internal
  *
- * @psalm-type SUPPORTED_CONTENT_TYPES = self::PROTOBUF|self::JSON|self::NDJSON
+ * @psalm-type SUPPORTED_CONTENT_TYPES = ContentTypes::PROTOBUF|ContentTypes::JSON|ContentTypes::NDJSON
  */
 final class ProtobufSerializer
 {
-    private const PROTOBUF = 'application/x-protobuf';
-    private const JSON = 'application/json';
-    private const NDJSON = 'application/x-ndjson';
-
     private function __construct(private string $contentType)
     {
     }
 
     public static function getDefault(): ProtobufSerializer
     {
-        return new self(self::PROTOBUF);
+        return new self(ContentTypes::PROTOBUF);
     }
 
     /**
@@ -51,35 +47,35 @@ public static function getDefault(): ProtobufSerializer
     public static function forTransport(TransportInterface $transport): ProtobufSerializer
     {
         return match ($contentType = $transport->contentType()) {
-            self::PROTOBUF, self::JSON, self::NDJSON => new self($contentType),
+            ContentTypes::PROTOBUF, ContentTypes::JSON, ContentTypes::NDJSON => new self($contentType),
             default => throw new InvalidArgumentException(sprintf('Not supported content type "%s"', $contentType)),
         };
     }
 
     public function serializeTraceId(string $traceId): string
     {
         return match ($this->contentType) {
-            self::PROTOBUF => $traceId,
-            self::JSON, self::NDJSON => base64_decode(bin2hex($traceId)),
+            ContentTypes::PROTOBUF => $traceId,
+            ContentTypes::JSON, ContentTypes::NDJSON => base64_decode(bin2hex($traceId)),
             default => throw new AssertionError(),
         };
     }
 
     public function serializeSpanId(string $spanId): string
     {
         return match ($this->contentType) {
-            self::PROTOBUF => $spanId,
-            self::JSON, self::NDJSON => base64_decode(bin2hex($spanId)),
+            ContentTypes::PROTOBUF => $spanId,
+            ContentTypes::JSON, ContentTypes::NDJSON => base64_decode(bin2hex($spanId)),
             default => throw new AssertionError(),
         };
     }
 
     public function serialize(Message $message): string
     {
         return match ($this->contentType) {
-            self::PROTOBUF => $message->serializeToString(),
-            self::JSON => self::postProcessJsonEnumValues($message, $message->serializeToJsonString()),
-            self::NDJSON => self::postProcessJsonEnumValues($message, $message->serializeToJsonString()) . "\n",
+            ContentTypes::PROTOBUF => $message->serializeToString(),
+            ContentTypes::JSON => self::postProcessJsonEnumValues($message, $message->serializeToJsonString()),
+            ContentTypes::NDJSON => self::postProcessJsonEnumValues($message, $message->serializeToJsonString()) . "\n",
             default => throw new AssertionError(),
         };
     }
@@ -90,8 +86,8 @@ public function serialize(Message $message): string
     public function hydrate(Message $message, string $payload): void
     {
         match ($this->contentType) {
-            self::PROTOBUF => $message->mergeFromString($payload),
-            self::JSON, self::NDJSON => $message->mergeFromJsonString($payload, true),
+            ContentTypes::PROTOBUF => $message->mergeFromString($payload),
+            ContentTypes::JSON, ContentTypes::NDJSON => $message->mergeFromJsonString($payload, true),
             default => throw new AssertionError(),
         };
     }

diff --git a/src/Extension/Propagator/CloudTrace/CloudTraceFormatter.php b/src/Extension/Propagator/CloudTrace/CloudTraceFormatter.php
@@ -20,8 +20,6 @@ final class CloudTraceFormatter
 
     /**
      * Generate a SpanContext object from the Trace Context header
-     *
-     * @return SpanContextInterface
      */
     public static function deserialize(string $header) : SpanContextInterface
     {
@@ -46,8 +44,6 @@ public static function deserialize(string $header) : SpanContextInterface
 
     /**
      * Convert a SpanContextInterface to header string
-     *
-     * @return string
      */
     public static function serialize(SpanContextInterface $context) : string
     {

diff --git a/src/SDK/Metrics/Aggregation/ExplicitBucketHistogramAggregation.php b/src/SDK/Metrics/Aggregation/ExplicitBucketHistogramAggregation.php
@@ -22,9 +22,7 @@ final class ExplicitBucketHistogramAggregation implements AggregationInterface
      * @param list<float|int> $boundaries strictly ascending histogram bucket boundaries
      */
     public function __construct(
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public array $boundaries
     ) {
     }

diff --git a/src/SDK/Metrics/Data/Exemplar.php b/src/SDK/Metrics/Data/Exemplar.php
@@ -8,32 +8,17 @@
 
 final class Exemplar
 {
-
-    /**
-     * @param int|string $index
-     * @param float|int $value
-     */
     public function __construct(
-        private $index,
-        /**
-         * @readonly
-         */
-        public $value,
-        /**
-         * @readonly
-         */
+        private int|string $index,
+        /** @readonly */
+        public float|int $value,
+        /** @readonly */
         public int $timestamp,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public AttributesInterface $attributes,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public ?string $traceId,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public ?string $spanId
     ) {
     }

diff --git a/src/SDK/Metrics/Data/Histogram.php b/src/SDK/Metrics/Data/Histogram.php
@@ -6,20 +6,14 @@
 
 final class Histogram implements DataInterface
 {
-
     /**
      * @param iterable<HistogramDataPoint> $dataPoints
-     * @param string|Temporality $temporality
      */
     public function __construct(
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public iterable $dataPoints,
-        /**
-         * @readonly
-         */
-        public $temporality
+        /** @readonly */
+        public string|Temporality $temporality
     ) {
     }
 }
diff --git a/src/SDK/Metrics/Data/HistogramDataPoint.php b/src/SDK/Metrics/Data/HistogramDataPoint.php
@@ -9,52 +9,29 @@
 final class HistogramDataPoint
 {
     /**
-     * @param float|int $sum
-     * @param float|int $min
-     * @param float|int $max
      * @param int[] $bucketCounts
      * @param list<float|int> $explicitBounds
      */
     public function __construct(
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public int $count,
-        /**
-         * @readonly
-         */
-        public $sum,
-        /**
-         * @readonly
-         */
-        public $min,
-        /**
-         * @readonly
-         */
-        public $max,
-        /**
-         * @readonly
-         */
+        /** @readonly */
+        public float|int $sum,
+        /** @readonly */
+        public float|int $min,
+        /** @readonly */
+        public float|int $max,
+        /** @readonly */
         public array $bucketCounts,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public array $explicitBounds,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public AttributesInterface $attributes,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public int $startTimestamp,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public int $timestamp,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public iterable $exemplars = []
     ) {
     }

diff --git a/src/SDK/Metrics/Data/NumberDataPoint.php b/src/SDK/Metrics/Data/NumberDataPoint.php
@@ -8,29 +8,16 @@
 
 final class NumberDataPoint
 {
-    /**
-     * @param float|int $value
-     */
     public function __construct(
-        /**
-         * @readonly
-         */
-        public $value,
-        /**
-         * @readonly
-         */
+        /** @readonly */
+        public float|int $value,
+        /** @readonly */
         public AttributesInterface $attributes,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public int $startTimestamp,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public int $timestamp,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public iterable $exemplars = []
     ) {
     }

diff --git a/src/SDK/Metrics/Data/Sum.php b/src/SDK/Metrics/Data/Sum.php
@@ -6,23 +6,15 @@
 
 final class Sum implements DataInterface
 {
-
     /**
      * @param iterable<NumberDataPoint> $dataPoints
-     * @param string|Temporality $temporality
      */
     public function __construct(
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public iterable $dataPoints,
-        /**
-         * @readonly
-         */
-        public $temporality,
-        /**
-         * @readonly
-         */
+        /** @readonly */
+        public string|Temporality $temporality,
+        /** @readonly */
         public bool $monotonic
     ) {
     }

diff --git a/src/SDK/Metrics/Instrument.php b/src/SDK/Metrics/Instrument.php
@@ -6,29 +6,16 @@
 
 final class Instrument
 {
-    /**
-     * @param string|InstrumentType $type
-     */
     public function __construct(
-        /**
-         * @readonly
-         */
-        public $type,
-        /**
-         * @readonly
-         */
+        /** @readonly */
+        public string|InstrumentType $type,
+        /** @readonly */
         public string $name,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public ?string $unit,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public ?string $description,
-        /**
-         * @readonly
-         */
+        /** @readonly */
         public array $advisory = []
     ) {
     }