Add Telemetry configuration and refactor related components

Introduced a new `Telemetry` class to handle OTEL configurations with support for endpoint, protocol, batch size, and sampling ratio. Updated `Settings` and `AccessLog` to support telemetry, enhance arrayable support, and included `TelemetryProtocolEnum`. Improved test coverage and streamlined consistency across various components.

Author: Pavlusha311245

composer.json

@@ -28,18 +28,18 @@
     "lint": "./vendor/bin/php-cs-fixer fix --rules=@PSR12 ."
   },
   "require": {
-    "php": "^8.3",
-    "friendsofphp/php-cs-fixer": "^3.54",
-    "guzzlehttp/guzzle": "^7.8.1",
-    "nesbot/carbon": "^2.72",
+    "php": "^8.3|^8.4",
+    "friendsofphp/php-cs-fixer": "^3.65",
+    "guzzlehttp/guzzle": "^7.9",
+    "nesbot/carbon": "^3.8",
     "doctrine/inflector": "^2.0",
     "ext-curl": "*"
   },
   "require-dev": {
-    "pestphp/pest": "^2.34",
-    "phpstan/phpstan": "^1.10",
+    "pestphp/pest": "^2.36",
+    "phpstan/phpstan": "^1.12",
     "mockery/mockery": "^1.6",
-    "fakerphp/faker": "^1.23"
+    "fakerphp/faker": "^1.24"
   },
   "autoload": {
     "psr-4": {

src/Builders/ApplicationBuilder.php

@@ -17,9 +17,10 @@
 class ApplicationBuilder
 {
     /**
-     * @throws UnitException
-     *
-     * TODO: add ApplicationTypeEnum as possible type
+     * @param $appName
+     * @param $appData
+     * @param string $type
+     * @return GoExternalApplication|JavaApplication|NodeJsExternalApplication|PerlApplication|PhpApplication|PythonApplication|RubyApplication|WebAssemblyApplication|WebAssemblyComponentApplication
      */
     public static function create($appName, $appData, string $type = '')
     {

src/Builders/EndpointBuilder.php

@@ -16,9 +16,12 @@ class EndpointBuilder
 {
     protected string $endpoint = '';
 
+    /**
+     * @param array|string $url
+     */
     public function __construct(
         // TODO: change with http extension
-        array|string $url = null
+        array|string $url = ''
     ) {
         $this->endpoint = '/' . (is_array($url) ? implode('/', $url) : $url);
     }

src/Config/AccessLog.php

@@ -3,10 +3,11 @@
 namespace UnitPhpSdk\Config;
 
 use UnitPhpSdk\Builders\EndpointBuilder;
+use UnitPhpSdk\Contracts\Arrayable;
 use UnitPhpSdk\Contracts\Uploadable;
 use UnitPhpSdk\Traits\CanUpload;
 
-class AccessLog implements Uploadable
+class AccessLog implements Uploadable, Arrayable
 {
     use CanUpload;
 
@@ -22,11 +23,12 @@ class AccessLog implements Uploadable
      *
      * @var string|mixed|null
      */
-    private ?string $format;
+    private string|array|null $format;
 
     public function __construct(
         array $data
-    ) {
+    )
+    {
         $this->path = $data['path'] ?? null;
         $this->format = $data['format'] ?? null;
 
@@ -64,4 +66,15 @@ public function setFormat(string $format): void
     {
         $this->format = $format;
     }
+
+    /**
+     * @inheritDoc
+     */
+    #[\Override] public function toArray(): array
+    {
+        return [
+            'path' => $this->path,
+            'format' => $this->format,
+        ];
+    }
 }

src/Config/Application/Targets/PhpTarget.php

@@ -19,15 +19,15 @@ class PhpTarget implements Arrayable
      *
      * @var string
      */
-    private string $script = 'index.php';
+    private string $script = '';
 
     /**
      * Filename added to URI paths that point to directories if no script is set
      * The requests are served according to their URI paths; if they point to directories, index is used.
      *
      * @var string
      */
-    private string $index = 'index.php';
+    private string $index = '';
 
     public function __construct(array $data)
     {

src/Config/Routes/ActionType/ShareAction.php

@@ -13,14 +13,18 @@ class ShareAction implements Arrayable
      *
      * @var string
      */
-    private string $index = 'index.html';
+    private string $index = '';
 
     /**
+     * Used if the request can’t be served by share or index.
+     *
      * @var array
      */
     private array $fallback = [];
 
     /**
+     * Used to filter the shared files.
+     *
      * @var array
      */
     private array $types = [];
@@ -41,24 +45,24 @@ class ShareAction implements Arrayable
     private bool $traverse_mounts = true;
 
     public function __construct(
-        private string $share,
+        private string|array $share,
         $data = []
     ) {
         $this->parseData($data);
     }
 
     /**
-     * @return string
+     * @return string|array
      */
-    public function getShare(): string
+    public function getShare(): string|array
     {
         return $this->share;
     }
 
     /**
      * @param string $share
      */
-    public function setShare(string $share): void
+    public function setShare(string|array $share): void
     {
         $this->share = $share;
     }

src/Config/Settings.php

@@ -2,8 +2,10 @@
 
 namespace UnitPhpSdk\Config;
 
+use InvalidArgumentException;
 use UnitPhpSdk\Builders\EndpointBuilder;
 use UnitPhpSdk\Config\Settings\Http;
+use UnitPhpSdk\Config\Settings\Telemetry;
 use UnitPhpSdk\Contracts\Arrayable;
 use UnitPhpSdk\Contracts\Jsonable;
 use UnitPhpSdk\Contracts\Uploadable;
@@ -13,6 +15,8 @@ class Settings implements Uploadable, Arrayable, Jsonable
 {
     use CanUpload;
 
+    private const array REQUIRED_TELEMETRY_KEYS = ['endpoint', 'protocol'];
+
     /**
      * Fine-tunes handling of HTTP requests from the clients
      *
@@ -25,6 +29,11 @@ class Settings implements Uploadable, Arrayable, Jsonable
      */
     private string|array $js_module = [];
 
+    /**
+     * @var Telemetry|mixed|null
+     */
+    private ?Telemetry $telemetry = null;
+
     public function __construct(array $data = [])
     {
         if (array_key_exists('http', $data)) {
@@ -35,6 +44,10 @@ public function __construct(array $data = [])
             $this->parseJsModule($data['js_module']);
         }
 
+        if (array_key_exists('telemetry', $data)) {
+            $this->parseTelemetry($data['telemetry']);
+        }
+
         $this->setApiEndpoint(EndpointBuilder::create($this)->get());
     }
 
@@ -56,6 +69,33 @@ private function parseJsModule(array|string $data): void
         $this->js_module = $data;
     }
 
+    private function parseTelemetry(array $data): void
+    {
+        $this->validateTelemetryData($data);
+
+        $this->telemetry = new Telemetry(
+            endpoint: $data['endpoint'],
+            protocol: $data['protocol']
+        );
+
+        if (array_key_exists('sampling_ratio', $data)) {
+            $this->telemetry->setSamplingRatio($data['sampling_ratio']);
+        }
+
+        if (array_key_exists('batch_size', $data)) {
+            $this->telemetry->setBatchSize($data['batch_size']);
+        }
+    }
+
+    private function validateTelemetryData(array $data): void
+    {
+        foreach (self::REQUIRED_TELEMETRY_KEYS as $key) {
+            if (empty($data[$key])) {
+                throw new InvalidArgumentException("Telemetry {$key} is required");
+            }
+        }
+    }
+
     /**
      * @return array|string
      */
@@ -85,6 +125,6 @@ public function setJsModule(array|string $js_module): void
      */
     #[\Override] public function toJson(int $options = 0): string
     {
-        return json_encode(array_filter($this->toArray(), fn ($item) => !empty($item)), $options);
+        return json_encode(array_filter($this->toArray(), fn($item) => !empty($item)), $options);
     }
 }

src/Config/Settings/Telemetry.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace UnitPhpSdk\Config\Settings;
+
+use UnitPhpSdk\Contracts\Arrayable;
+use UnitPhpSdk\Contracts\Jsonable;
+use UnitPhpSdk\Enums\TelemetryProtocolEnum;
+
+class Telemetry implements Arrayable, Jsonable
+{
+    /**
+     * Number of spans to cache before triggering a transaction with the configured endpoint. This is optional.
+     *
+     * @var int|null $batch_size
+     */
+    private ?int $batch_size = 50;
+
+    /**
+     * Percentage of requests to trace. This is optional.
+     *
+     * @var float|null $sampling_ratio
+     */
+    private ?float $sampling_ratio = 1.0;
+
+    public function __construct(
+        /**
+         * The endpoint for the OpenTelemetry (OTEL) Collector. This is required.
+         *
+         * @var string $endpoint
+         */
+        private string                $endpoint,
+        /**
+         * Determines the protocol used to communicate with the endpoint. This is required.
+         *
+         * @var TelemetryProtocolEnum $protocol
+         */
+        private TelemetryProtocolEnum $protocol
+    )
+    {
+        $this->setEndpoint($endpoint);
+        $this->setProtocol($protocol);
+    }
+
+    public function getEndpoint(): string
+    {
+        return $this->endpoint;
+    }
+
+    public function setEndpoint(string $endpoint): void
+    {
+        $this->endpoint = $endpoint;
+    }
+
+    public function getProtocol(): TelemetryProtocolEnum
+    {
+        return $this->protocol;
+    }
+
+    public function setProtocol(TelemetryProtocolEnum $protocol): void
+    {
+        $this->protocol = $protocol;
+    }
+
+    public function getBatchSize(): ?int
+    {
+        return $this->batch_size;
+    }
+
+    public function setBatchSize(?int $batch_size): void
+    {
+        $this->batch_size = $batch_size;
+    }
+
+    public function getSamplingRatio(): ?float
+    {
+        return $this->sampling_ratio;
+    }
+
+    public function setSamplingRatio(?float $sampling_ratio): void
+    {
+        $this->sampling_ratio = $sampling_ratio;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    #[\Override] public function toArray(): array
+    {
+        return [
+            'endpoint' => $this->getEndpoint(),
+            'protocol' => $this->getProtocol(),
+            'batch_size' => $this->getBatchSize(),
+            'sampling_ratio' => $this->getSamplingRatio()
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    #[\Override] public function toJson(int $options = 0): string
+    {
+        return json_encode($this->toArray(), $options);
+    }
+}

src/Enums/TelemetryProtocolEnum.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace UnitPhpSdk\Enums;
+
+enum TelemetryProtocolEnum: string
+{
+    case HTTP = 'http';
+    case GRPC = 'grpc';
+}

src/Traits/CanUpload.php

@@ -49,10 +49,6 @@ public function upload(UnitRequest $request)
     {
         $data = $this->removeEmptyArrays($this->toArray());
 
-        echo '<pre>';
-        print_r(json_encode($data));
-        echo '</pre>';
-
         try {
             $request->setMethod(HttpMethodsEnum::PUT->value)->send(
                 $this->getApiEndpoint(),