Add support for observability.

composer.json

@@ -27,6 +27,8 @@
 		"php-http/promise": "^1.1.0",
 		"league/uri": "^6.5",
 		"doctrine/annotations": "^1.13 || ^2.0",
+		"open-telemetry/sdk": "^0.0.17",
+		"open-telemetry/api": "^0.0.17",
 		"ramsey/uuid": "^3 || ^4"
 	},
     "require-dev": {

src/Constants.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Microsoft\Kiota\Abstractions;
+
+final class Constants
+{
+    public const VERSION = '0.8.1';
+}

src/ObservabilityOptions.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Microsoft\Kiota\Abstractions;
+
+use OpenTelemetry\API\Common\Instrumentation\Globals;
+use OpenTelemetry\API\Trace\TracerInterface;
+
+class ObservabilityOptions implements RequestOption
+{
+    private static ?TracerInterface $tracer = null;
+    private const OBSERVABILITY_TRACER_NAME = 'microsoft-php-kiota-abstractions';
+    public const REQUEST_TYPE_KEY = "com.microsoft.kiota.request.type";
+
+    /**
+     * @return TracerInterface
+     */
+    public static function getTracer(): TracerInterface
+    {
+        if (self::$tracer === null) {
+            self::$tracer = Globals::tracerProvider()->getTracer(self::OBSERVABILITY_TRACER_NAME, Constants::VERSION);
+        }
+        return self::$tracer;
+    }
+
+    public static function setTracer(TracerInterFace $tracer): void
+    {
+        self::$tracer = $tracer;
+    }
+}

src/RequestInformation.php

@@ -39,7 +39,7 @@ class RequestInformation {
     private array $requestOptions = [];
     /** @var string $binaryContentType */
     private static string $binaryContentType = 'application/octet-stream';
-    /** @var string $contentTypeHeader */
+    /** @var non-empty-string $contentTypeHeader */
     public static string $contentTypeHeader = 'Content-Type';
     private static AnnotationReader $annotationReader;
 
@@ -152,13 +152,20 @@ public function setStreamContent(StreamInterface $value): void {
      * @param Parsable $value the models.
      */
     public function setContentFromParsable(RequestAdapter $requestAdapter, string $contentType, Parsable $value): void {
+        $span = ObservabilityOptions::getTracer()->spanBuilder('setContentFromParsableCollection')
+            ->startSpan();
+        $scope = $span->activate();
         try {
             $writer = $requestAdapter->getSerializationWriterFactory()->getSerializationWriter($contentType);
             $writer->writeObjectValue(null, $value);
+            $span->setAttribute(ObservabilityOptions::REQUEST_TYPE_KEY, get_class($value));
             $this->headers->add(self::$contentTypeHeader, $contentType);
             $this->content = $writer->getSerializedContent();
         } catch (Exception $exception) {
             throw new RuntimeException('could not serialize payload.', 1, $exception);
+        } finally {
+            $scope->detach();
+            $span->end();
         }
     }
 
@@ -172,13 +179,23 @@ public function setContentFromParsable(RequestAdapter $requestAdapter, string $c
      */
     public function setContentFromParsableCollection(RequestAdapter $requestAdapter, string $contentType, array $values): void
     {
+        $span = ObservabilityOptions::getTracer()->spanBuilder('setContentFromParsableCollection')
+            ->startSpan();
+        $scope = $span->activate();
         try {
             $writer = $requestAdapter->getSerializationWriterFactory()->getSerializationWriter($contentType);
             $writer->writeCollectionOfObjectValues(null, $values);
+            $span->setAttribute(self::$contentTypeHeader, $contentType);
+            if (!empty($values)) {
+                $span->setAttribute(ObservabilityOptions::REQUEST_TYPE_KEY, get_class($values[0]));
+            }
             $this->headers->add(self::$contentTypeHeader, $contentType);
             $this->content = $writer->getSerializedContent();
         } catch (Exception $exception) {
             throw new RuntimeException('could not serialize payload.', 1, $exception);
+        } finally {
+            $scope->detach();
+            $span->end();
         }
     }
 
@@ -191,13 +208,21 @@ public function setContentFromParsableCollection(RequestAdapter $requestAdapter,
      * @return void
      */
     public function setContentFromScalar(RequestAdapter $requestAdapter, string $contentType, $value): void {
+        $span = ObservabilityOptions::getTracer()->spanBuilder('setContentFromScalar')
+            ->startSpan();
+        $scope = $span->activate();
         try {
             $writer = $requestAdapter->getSerializationWriterFactory()->getSerializationWriter($contentType);
             $writer->writeAnyValue(null, $value);
+            $span->setAttribute(self::$contentTypeHeader, $contentType);
+            $span->setAttribute(ObservabilityOptions::REQUEST_TYPE_KEY, gettype($value));
             $this->headers->add(self::$contentTypeHeader, $contentType);
             $this->content = $writer->getSerializedContent();
         } catch (Exception $exception) {
             throw new RuntimeException('could not serialize payload.', 1, $exception);
+        } finally {
+            $scope->detach();
+            $span->end();
         }
     }
 
@@ -210,13 +235,23 @@ public function setContentFromScalar(RequestAdapter $requestAdapter, string $con
      * @return void
      */
     public function setContentFromScalarCollection(RequestAdapter $requestAdapter, string $contentType, array $values): void {
+        $span = ObservabilityOptions::getTracer()->spanBuilder('setContentFromScalarCollection')
+            ->startSpan();
+        $scope = $span->activate();
         try {
             $writer = $requestAdapter->getSerializationWriterFactory()->getSerializationWriter($contentType);
             $writer->writeCollectionOfPrimitiveValues(null, $values);
+            $span->setAttribute(self::$contentTypeHeader, $contentType);
+            if (!empty($values)) {
+                $span->setAttribute(ObservabilityOptions::REQUEST_TYPE_KEY, gettype($values[0]));
+            }
             $this->headers->add(self::$contentTypeHeader, $contentType);
             $this->content = $writer->getSerializedContent();
         } catch (Exception $exception) {
             throw new RuntimeException('could not serialize payload.', 1, $exception);
+        } finally {
+            $scope->detach();
+            $span->end();
         }
     }
 

src/Serialization/SerializationWriter.php

@@ -6,6 +6,7 @@
 use Microsoft\Kiota\Abstractions\Enum;
 use Microsoft\Kiota\Abstractions\Types\Date;
 use Microsoft\Kiota\Abstractions\Types\Time;
+use OpenTelemetry\API\Trace\SpanInterface;
 use Psr\Http\Message\StreamInterface;
 
 /** Defines an interface for serialization of objects to a stream. */
@@ -128,7 +129,7 @@ public function writeCollectionOfPrimitiveValues(?string $key, ?array $value): v
     * @param string|null $key The key for the value.
     * @param mixed|null $value.
     **/
-    public function writeAnyValue(?string $key, $value): void;
+    public function writeAnyValue(?string $key, $value, ?SpanInterface $span = null): void;
 
     /**
      * Write a binary stream.