Implemented remove method for metric

phpstreamserver · Nov 14, 2024 · 98b142b · 98b142b
1 parent 02ac176
commit 98b142b
Show file tree

Hide file tree

Showing 10 changed files with 112 additions and 30 deletions.
diff --git a/src/BundledPlugin/Metrics/Counter.php b/src/BundledPlugin/Metrics/Counter.php
@@ -11,6 +11,8 @@
 
 final class Counter extends Metric
 {
+    protected const TYPE = 'counter';
+
     private array $buffer = [];
 
     /**

diff --git a/src/BundledPlugin/Metrics/Gauge.php b/src/BundledPlugin/Metrics/Gauge.php
@@ -11,6 +11,8 @@
 
 final class Gauge extends Metric
 {
+    protected const TYPE = 'gauge';
+
     private array $buffer = [];
 
     /**

diff --git a/src/BundledPlugin/Metrics/Histogram.php b/src/BundledPlugin/Metrics/Histogram.php
@@ -11,6 +11,8 @@
 
 final class Histogram extends Metric
 {
+    protected const TYPE = 'histogram';
+
     private array $buffer = [];
 
     /**

diff --git a/src/BundledPlugin/Metrics/Internal/InMemory.php b/src/BundledPlugin/Metrics/Internal/InMemory.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal;
+
+use Prometheus\Storage\InMemory as PrometheusInMemory;
+
+final class InMemory extends PrometheusInMemory
+{
+    public function remove(string $type, string $namespace, string $name, array $labels): void
+    {
+        $data = [
+            'type' => $type,
+            'name' => $namespace . '_' . $name,
+            'labelValues' => $labels,
+        ];
+
+        $metaKey = $this->metaKey($data);
+        $valueKey = $this->valueKey($data);
+
+        if ($type === 'counter') {
+            unset($this->counters[$metaKey]['samples'][$valueKey]);
+        } elseif($type === 'gauge') {
+            unset($this->gauges[$metaKey]['samples'][$valueKey]);
+        } elseif($type === 'histogram') {
+            unset($this->histograms[$metaKey]['samples'][$valueKey]);
+        } elseif($type === 'summary') {
+            unset($this->summaries[$metaKey]['samples'][$valueKey]);
+        }
+    }
+}
diff --git a/src/BundledPlugin/Metrics/Internal/Message/GetMetricMessage.php b/src/BundledPlugin/Metrics/Internal/Message/GetMetricMessage.php
@@ -11,11 +11,6 @@
  */
 final readonly class GetMetricMessage implements MessageInterface
 {
-    public const TYPE_COUNTER = 'counter';
-    public const TYPE_GAUGE = 'gauge';
-    public const TYPE_HISTOGRAM = 'histogram';
-    public const TYPE_SUMMARY = 'summary';
-
     private function __construct(
         public string $type,
         public string $namespace,
@@ -25,21 +20,21 @@ private function __construct(
 
     public static function counter(string $namespace, string $name): self
     {
-        return new self(self::TYPE_COUNTER, $namespace, $name);
+        return new self('counter', $namespace, $name);
     }
 
     public static function gauge(string $namespace, string $name): self
     {
-        return new self(self::TYPE_GAUGE, $namespace, $name);
+        return new self('gauge', $namespace, $name);
     }
 
     public static function histogram(string $namespace, string $name): self
     {
-        return new self(self::TYPE_HISTOGRAM, $namespace, $name);
+        return new self('histogram', $namespace, $name);
     }
 
     public static function summary(string $namespace, string $name): self
     {
-        return new self(self::TYPE_SUMMARY, $namespace, $name);
+        return new self('summary', $namespace, $name);
     }
 }
diff --git a/src/BundledPlugin/Metrics/Internal/Message/RegisterMetricMessage.php b/src/BundledPlugin/Metrics/Internal/Message/RegisterMetricMessage.php
@@ -11,11 +11,6 @@
  */
 final readonly class RegisterMetricMessage implements MessageInterface
 {
-    public const TYPE_COUNTER = 'counter';
-    public const TYPE_GAUGE = 'gauge';
-    public const TYPE_HISTOGRAM = 'histogram';
-    public const TYPE_SUMMARY = 'summary';
-
     private function __construct(
         public string $type,
         public string $namespace,
@@ -28,21 +23,21 @@ private function __construct(
 
     public static function counter(string $namespace, string $name, string $help, array $labels): self
     {
-        return new self(self::TYPE_COUNTER, $namespace, $name, $help, $labels);
+        return new self('counter', $namespace, $name, $help, $labels);
     }
 
     public static function gauge(string $namespace, string $name, string $help, array $labels): self
     {
-        return new self(self::TYPE_GAUGE, $namespace, $name, $help, $labels);
+        return new self('gauge', $namespace, $name, $help, $labels);
     }
 
     public static function histogram(string $namespace, string $name, string $help, array $labels, array $buckets): self
     {
-        return new self(self::TYPE_HISTOGRAM, $namespace, $name, $help, $labels, $buckets);
+        return new self('histogram', $namespace, $name, $help, $labels, $buckets);
     }
 
     public static function summary(string $namespace, string $name, string $help, array $labels, array|null $buckets = null): self
     {
-        return new self(self::TYPE_SUMMARY, $namespace, $name, $help, $labels, $buckets);
+        return new self('summary', $namespace, $name, $help, $labels, $buckets);
     }
 }
diff --git a/src/BundledPlugin/Metrics/Internal/Message/RemoveMetricMessage.php b/src/BundledPlugin/Metrics/Internal/Message/RemoveMetricMessage.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message;
+
+use Luzrain\PHPStreamServer\MessageBus\MessageInterface;
+
+/**
+ * @implements MessageInterface<null>
+ */
+final readonly class RemoveMetricMessage implements MessageInterface
+{
+    public function __construct(
+        public string $type,
+        public string $namespace,
+        public string $name,
+        public array $labels,
+    ) {
+    }
+}
diff --git a/src/BundledPlugin/Metrics/Internal/MessageBusRegistryHandler.php b/src/BundledPlugin/Metrics/Internal/MessageBusRegistryHandler.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal;
 
 use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\GetMetricMessage;
@@ -8,46 +10,49 @@
 use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\ObserveHistorgamMessage;
 use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\ObserveSummaryMessage;
 use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\RegisterMetricMessage;
+use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\RemoveMetricMessage;
 use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\SetGaugeMessage;
 use Luzrain\PHPStreamServer\MessageBus\MessageHandlerInterface;
 use Prometheus\CollectorRegistry;
 use Prometheus\Exception\MetricNotFoundException as PrometheusMetricNotFoundException;
 use Prometheus\Exception\MetricsRegistrationException as PrometheusMetricRegistrationException;
 use Prometheus\RegistryInterface as PrometheusRegistryInterface;
 use Prometheus\RenderTextFormat;
-use Prometheus\Storage\InMemory;
 use function Amp\weakClosure;
 
 final class MessageBusRegistryHandler
 {
+    private InMemory $adapter;
     private PrometheusRegistryInterface $registry;
 
     public function __construct(MessageHandlerInterface $messageHandler)
     {
-        $this->registry = new CollectorRegistry(new InMemory(), false);
+        $this->adapter = new InMemory();
+        $this->registry = new CollectorRegistry($this->adapter, false);
 
         $messageHandler->subscribe(RegisterMetricMessage::class, weakClosure($this->registerMetric(...)));
         $messageHandler->subscribe(GetMetricMessage::class, weakClosure($this->getMetric(...)));
         $messageHandler->subscribe(IncreaseCounterMessage::class, weakClosure($this->increaseCounter(...)));
         $messageHandler->subscribe(SetGaugeMessage::class, weakClosure($this->setGauge(...)));
         $messageHandler->subscribe(ObserveHistorgamMessage::class, weakClosure($this->observeHistogram(...)));
         $messageHandler->subscribe(ObserveSummaryMessage::class, weakClosure($this->observeSummary(...)));
+        $messageHandler->subscribe(RemoveMetricMessage::class, weakClosure($this->removeMetric(...)));
     }
 
     private function registerMetric(RegisterMetricMessage $message): bool
     {
         try {
             match ($message->type) {
-                RegisterMetricMessage::TYPE_COUNTER => $this->registry->registerCounter(
+                'counter' => $this->registry->registerCounter(
                     $message->namespace, $message->name, $message->help, $message->labels,
                 ),
-                RegisterMetricMessage::TYPE_GAUGE => $this->registry->registerGauge(
+                'gauge' => $this->registry->registerGauge(
                     $message->namespace, $message->name, $message->help, $message->labels,
                 ),
-                RegisterMetricMessage::TYPE_HISTOGRAM => $this->registry->registerHistogram(
+                'histogram' => $this->registry->registerHistogram(
                     $message->namespace, $message->name, $message->help, $message->labels, $message->buckets,
                 ),
-                RegisterMetricMessage::TYPE_SUMMARY => $this->registry->registerSummary(
+                'summary' => $this->registry->registerSummary(
                     $message->namespace, $message->name, $message->help, $message->labels, 600, $message->buckets,
                 ),
             };
@@ -61,17 +66,35 @@ private function registerMetric(RegisterMetricMessage $message): bool
     private function getMetric(GetMetricMessage $message): GetMetricResponse|false
     {
         try {
-            $counter = match ($message->type) {
-                GetMetricMessage::TYPE_COUNTER => $this->registry->getCounter($message->namespace, $message->name),
-                GetMetricMessage::TYPE_GAUGE => $this->registry->getGauge($message->namespace, $message->name),
-                GetMetricMessage::TYPE_HISTOGRAM => $this->registry->getHistogram($message->namespace, $message->name),
-                GetMetricMessage::TYPE_SUMMARY => $this->registry->getSummary($message->namespace, $message->name),
+            $metric = match ($message->type) {
+                'counter' => $this->registry->getCounter($message->namespace, $message->name),
+                'gauge' => $this->registry->getGauge($message->namespace, $message->name),
+                'histogram' => $this->registry->getHistogram($message->namespace, $message->name),
+                'summary' => $this->registry->getSummary($message->namespace, $message->name),
             };
         } catch (PrometheusMetricNotFoundException) {
             return false;
         }
 
-        return new GetMetricResponse($message->type, $message->namespace, $message->name, $counter->getHelp(), $counter->getLabelNames());
+        return new GetMetricResponse($message->type, $message->namespace, $message->name, $metric->getHelp(), $metric->getLabelNames());
+    }
+
+    private function removeMetric(RemoveMetricMessage $message): void
+    {
+        try {
+            $metric = match ($message->type) {
+                'counter' => $this->registry->getCounter($message->namespace, $message->name),
+                'gauge' => $this->registry->getGauge($message->namespace, $message->name),
+                'histogram' => $this->registry->getHistogram($message->namespace, $message->name),
+                'summary' => $this->registry->getSummary($message->namespace, $message->name),
+            };
+        } catch (PrometheusMetricNotFoundException) {
+            return;
+        }
+
+        $labels = [...\array_flip($metric->getLabelNames()), ...$message->labels];
+
+        $this->adapter->remove($message->type, $message->namespace, $message->name, $labels);
     }
 
     private function increaseCounter(IncreaseCounterMessage $message): void

diff --git a/src/BundledPlugin/Metrics/Internal/Metric.php b/src/BundledPlugin/Metrics/Internal/Metric.php
@@ -5,10 +5,12 @@
 namespace Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal;
 
 use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Exception\LabelsNotMatchException;
+use Luzrain\PHPStreamServer\BundledPlugin\Metrics\Internal\Message\RemoveMetricMessage;
 use Luzrain\PHPStreamServer\MessageBus\MessageBusInterface;
 
 abstract class Metric
 {
+    protected const TYPE = '';
     protected const FLUSH_TIMEOUT = 0.2;
 
     private int $labelsCount;
@@ -23,6 +25,12 @@ public function __construct(
         $this->labelsCount = \count($this->labels);
     }
 
+    public function remove(array $labels = []): void
+    {
+        $this->checkLabels($labels);
+        $this->messageBus->dispatch(new RemoveMetricMessage(static::TYPE, $this->namespace, $this->name, $labels));
+    }
+
     /**
      * @throws LabelsNotMatchException
      */

diff --git a/src/BundledPlugin/Metrics/Summary.php b/src/BundledPlugin/Metrics/Summary.php
@@ -11,6 +11,8 @@
 
 final class Summary extends Metric
 {
+    protected const TYPE = 'summary';
+
     private array $buffer = [];
 
     /**