chore: review feedback

Author: basert

README.md

@@ -0,0 +1,47 @@
+# Utopia Telemetry
+
+![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/telemetry.svg)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://appwrite.io/discord)
+
+Utopia Telemetry is a powerful Telemtry library. This library is aiming to be as simple and easy to learn and use. This library is maintained by the [Appwrite team](https://appwrite.io).
+
+Although this library is part of the [Utopia System](https://github.com/utopia-php) project it is dependency free and can be used as standalone with any other PHP project or framework.
+
+## Getting Started
+
+Install using composer:
+
+```bash
+composer require utopia-php/telemetry
+```
+
+Init in your application:
+
+```php
+<?php
+
+require_once __DIR__ . '/vendor/autoload.php';
+
+// Create a Telemetry instance using OpenTelemetry adapter.
+use Utopia\Telemetry\Adapter\OpenTelemetry;
+
+$telemetry = new OpenTelemetry('http://localhost:4138', 'namespace', 'app', 'unique-instance-name');
+$counter = $telemetry->createUpDownCounter('http.server.active_requests', '{request}');
+
+$counter->add(1);
+$counter->add(2);
+
+// Periodically collect metrics and send them to the configured OpenTelemetry endpoint.
+$telemetry->collect();
+
+// Example using Swoole
+\Swoole\Timer::tick(60_000, fn () => $telemetry->collect());
+```
+
+## System Requirements
+
+Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
+
+## Copyright and license
+
+The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)

phpstan.neon

@@ -1,5 +1,4 @@
 parameters:
     level: 5
     paths:
-        - src
-        - tests
+        - src

src/Telemetry/Adapter/Noop.php src/Telemetry/Adapter/None.phpsrc/Telemetry/Adapter/Noop.php renamed to src/Telemetry/Adapter/None.php

@@ -8,26 +8,42 @@
 use Utopia\Telemetry\Histogram;
 use Utopia\Telemetry\UpDownCounter;
 
-class Noop implements Adapter
+class None implements Adapter
 {
     public function createCounter(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): Counter
     {
-        return new Counter();
+        return new class () extends Counter {
+            public function add(float|int $amount, iterable $attributes = []): void
+            {
+            }
+        };
     }
 
     public function createHistogram(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): Histogram
     {
-        return new Histogram();
+        return new class () extends Histogram {
+            public function record(float|int $amount, iterable $attributes = []): void
+            {
+            }
+        };
     }
 
     public function createGauge(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): Gauge
     {
-        return new Gauge();
+        return new class () extends Gauge {
+            public function record(float|int $amount, iterable $attributes = []): void
+            {
+            }
+        };
     }
 
     public function createUpDownCounter(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): UpDownCounter
     {
-        return new UpDownCounter();
+        return new class () extends UpDownCounter {
+            public function add(float|int $amount, iterable $attributes = []): void
+            {
+            }
+        };
     }
 
     public function collect(): bool

src/Telemetry/Adapter/OpenTelemetry.php

@@ -11,6 +11,8 @@
 use OpenTelemetry\Contrib\Otlp\MetricExporter;
 use OpenTelemetry\Contrib\Otlp\OtlpHttpTransportFactory;
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Attribute\AttributesInterface;
+use OpenTelemetry\SDK\Metrics\Data\Temporality;
 use OpenTelemetry\SDK\Metrics\MeterProvider;
 use OpenTelemetry\SDK\Metrics\MetricExporterInterface;
 use OpenTelemetry\SDK\Metrics\MetricReader\ExportingReader;
@@ -28,6 +30,12 @@ class OpenTelemetry implements Adapter
 {
     private MetricReaderInterface $reader;
     private MeterInterface $meter;
+    private array $meterStorage = [
+        Counter::class => [],
+        UpDownCounter::class => [],
+        Histogram::class => [],
+        Gauge::class => [],
+    ];
 
     public function __construct(string $endpoint, string $serviceNamespace, string $serviceName, string $serviceInstanceId)
     {
@@ -40,7 +48,7 @@ public function __construct(string $endpoint, string $serviceNamespace, string $
         $this->meter = $this->initMeter($exporter, $attributes);
     }
 
-    protected function initMeter(MetricExporterInterface $exporter, Attributes $attributes): MeterInterface
+    protected function initMeter(MetricExporterInterface $exporter, AttributesInterface $attributes): MeterInterface
     {
         $this->reader = new ExportingReader($exporter);
         $meterProvider = MeterProvider::builder()
@@ -56,12 +64,21 @@ protected function initMeter(MetricExporterInterface $exporter, Attributes $attr
     protected function createExporter(string $endpoint): MetricExporterInterface
     {
         $transport = (new OtlpHttpTransportFactory())->create($endpoint, ContentTypes::PROTOBUF);
-        return new MetricExporter($transport);
+        return new MetricExporter($transport, Temporality::CUMULATIVE);
+    }
+
+    private function createMeter(string $type, string $name, callable $creator): mixed
+    {
+        if (!isset($this->meterStorage[$type][$name])) {
+            $this->meterStorage[$type][$name] = $creator();
+        }
+
+        return $this->meterStorage[$type][$name];
     }
 
     public function createCounter(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): Counter
     {
-        $counter = $this->meter->createCounter($name, $unit, $description, $advisory);
+        $counter = $this->createMeter(Counter::class, $name, fn () => $this->meter->createCounter($name, $unit, $description, $advisory));
         return new class ($counter) extends Counter {
             public function __construct(private CounterInterface $counter)
             {
@@ -75,12 +92,12 @@ public function add(float|int $amount, iterable $attributes = []): void
 
     public function createHistogram(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): Histogram
     {
-        $histogram = $this->meter->createHistogram($name, $unit, $description, $advisory);
+        $histogram = $this->createMeter(Histogram::class, $name, fn () => $this->meter->createHistogram($name, $unit, $description, $advisory));
         return new class ($histogram) extends Histogram {
             public function __construct(private HistogramInterface $histogram)
             {
             }
-            public function add(float|int $amount, iterable $attributes = []): void
+            public function record(float|int $amount, iterable $attributes = []): void
             {
                 $this->histogram->record($amount, $attributes);
             }
@@ -89,12 +106,12 @@ public function add(float|int $amount, iterable $attributes = []): void
 
     public function createGauge(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): Gauge
     {
-        $gauge = $this->meter->createGauge($name, $unit, $description, $advisory);
+        $gauge = $this->createMeter(Gauge::class, $name, fn () => $this->meter->createGauge($name, $unit, $description, $advisory));
         return new class ($gauge) extends Gauge {
             public function __construct(private GaugeInterface $gauge)
             {
             }
-            public function add(float|int $amount, iterable $attributes = []): void
+            public function record(float|int $amount, iterable $attributes = []): void
             {
                 $this->gauge->record($amount, $attributes);
             }
@@ -103,7 +120,7 @@ public function add(float|int $amount, iterable $attributes = []): void
 
     public function createUpDownCounter(string $name, ?string $unit = null, ?string $description = null, array $advisory = []): UpDownCounter
     {
-        $upDownCounter = $this->meter->createUpDownCounter($name, $unit, $description, $advisory);
+        $upDownCounter = $this->createMeter(UpDownCounter::class, $name, fn () => $this->meter->createUpDownCounter($name, $unit, $description, $advisory));
         return new class ($upDownCounter) extends UpDownCounter {
             public function __construct(private UpDownCounterInterface $upDownCounter)
             {

src/Telemetry/Counter.php

@@ -2,9 +2,7 @@
 
 namespace Utopia\Telemetry;
 
-class Counter
+abstract class Counter
 {
-    public function add(float|int $amount, iterable $attributes = []): void
-    {
-    }
+    abstract public function add(float|int $amount, iterable $attributes = []): void;
 }

src/Telemetry/Gauge.php

@@ -2,9 +2,7 @@
 
 namespace Utopia\Telemetry;
 
-class Gauge
+abstract class Gauge
 {
-    public function record(float|int $amount, iterable $attributes = []): void
-    {
-    }
+    abstract public function record(float|int $amount, iterable $attributes = []): void;
 }

src/Telemetry/Histogram.php

@@ -2,9 +2,7 @@
 
 namespace Utopia\Telemetry;
 
-class Histogram
+abstract class Histogram
 {
-    public function record(float|int $amount, iterable $attributes = []): void
-    {
-    }
+    abstract public function record(float|int $amount, iterable $attributes = []): void;
 }

src/Telemetry/UpDownCounter.php

@@ -2,9 +2,7 @@
 
 namespace Utopia\Telemetry;
 
-class UpDownCounter
+abstract class UpDownCounter
 {
-    public function add(float|int $amount, iterable $attributes = []): void
-    {
-    }
+    abstract public function add(float|int $amount, iterable $attributes = []): void;
 }