was added a custom json exception for metrics

PromPHP · Jan 27, 2025 · ea6aeb7 · ea6aeb7
1 parent cbbf444
commit ea6aeb7
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 10 deletions.
diff --git a/src/Prometheus/Exception/MetricJsonException.php b/src/Prometheus/Exception/MetricJsonException.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Prometheus\Exception;
+
+use Exception;
+
+/**
+ * Exception thrown if a metric can't be found in the CollectorRegistry.
+ */
+class MetricJsonException extends Exception
+{
+
+    private $metricMetaData;
+    public function __construct($message = "", $code = 0, Exception $previous = null, string $metricMetaData)
+    {
+        parent::__construct($message, $code, $previous);
+        $this->metricMetaData = $metricMetaData;
+    }
+
+    public function getMetricMetaData(): string
+    {
+        return $this->metricMetaData;
+    }
+}
diff --git a/src/Prometheus/Storage/Redis.php b/src/Prometheus/Storage/Redis.php
@@ -6,6 +6,7 @@
 
 use InvalidArgumentException;
 use Prometheus\Counter;
+use Prometheus\Exception\MetricJsonException;
 use Prometheus\Exception\StorageException;
 use Prometheus\Gauge;
 use Prometheus\Histogram;
@@ -433,7 +434,7 @@ private function collectHistograms(): array
                 $allLabelValues[] = $d['labelValues'];
             }
             if (json_last_error() !== JSON_ERROR_NONE) {
-                $this->throwStorageExceptionOnJsonError($key, $raw);
+                $this->throwMetricJsonException($key, $raw);
             }
 
             // We need set semantics.
@@ -624,7 +625,7 @@ private function collectGauges(bool $sortMetrics = true): array
             }
 
             if (json_last_error() !== JSON_ERROR_NONE) {
-                $this->throwStorageExceptionOnJsonError($key, $raw);
+                $this->throwMetricJsonException($key, $raw);
             }
             if ($sortMetrics) {
                 usort($gauge['samples'], function ($a, $b): int {
@@ -663,7 +664,7 @@ private function collectCounters(bool $sortMetrics = true): array
             }
 
             if (json_last_error() !== JSON_ERROR_NONE) {
-                $this->throwStorageExceptionOnJsonError($key, $raw);
+                $this->throwMetricJsonException($key, $raw);
             }
             if ($sortMetrics) {
                 usort($counter['samples'], function ($a, $b): int {
@@ -735,10 +736,10 @@ private function decodeLabelValues(string $values): array
         return $decodedValues;
     }
 
-    private function throwStorageExceptionOnJsonError(string $redisKey, $raw): void
+    private function throwMetricJsonException(string $redisKey, $raw): void
     {
         $metaData = is_array($raw) && isset($raw['_meta']) ? $raw['_meta'] : 'undefined';
         $message = 'Json error: ' . json_last_error_msg() . ' redis key : ' . $redisKey . ' raw meta data: ' . $metaData;
-        throw new StorageException($message, 0);
+        throw new MetricJsonException($message, 0, null, $metaData);
     }
 }
diff --git a/src/Prometheus/Storage/RedisNg.php b/src/Prometheus/Storage/RedisNg.php
@@ -6,6 +6,7 @@
 
 use InvalidArgumentException;
 use Prometheus\Counter;
+use Prometheus\Exception\MetricJsonException;
 use Prometheus\Exception\StorageException;
 use Prometheus\Gauge;
 use Prometheus\Histogram;
@@ -430,7 +431,7 @@ private function collectHistograms(): array
             }
 
             if (json_last_error() !== JSON_ERROR_NONE) {
-                $this->throwStorageExceptionOnJsonError($key, $raw);
+                $this->throwMetricJsonException($key, $raw);
             }
 
             // We need set semantics.
@@ -606,7 +607,7 @@ private function collectGauges(bool $sortMetrics = true): array
             }
 
             if (json_last_error() !== JSON_ERROR_NONE) {
-                $this->throwStorageExceptionOnJsonError($key, $raw);
+                $this->throwMetricJsonException($key, $raw);
             }
 
             if ($sortMetrics) {
@@ -643,7 +644,7 @@ private function collectCounters(bool $sortMetrics = true): array
             }
 
             if (json_last_error() !== JSON_ERROR_NONE) {
-                $this->throwStorageExceptionOnJsonError($key, $raw);
+                $this->throwMetricJsonException($key, $raw);
             }
 
             if ($sortMetrics) {
@@ -716,10 +717,10 @@ private function decodeLabelValues(string $values): array
         return $decodedValues;
     }
 
-    private function throwStorageExceptionOnJsonError(string $redisKey, $raw): void
+    private function throwMetricJsonException(string $redisKey, $raw): void
     {
         $metaData = is_array($raw) && isset($raw['_meta']) ? $raw['_meta'] : 'undefined';
         $message = 'Json error: ' . json_last_error_msg() . ' redis key : ' . $redisKey . ' raw meta data: ' . $metaData;
-        throw new StorageException($message, 0);
+        throw new MetricJsonException($message, 0, null, $metaData);
     }
 }