Learned how to wipe the storage adapter from the registry (#89)

* Learned how to wipe the storage adapter from the registry Signed-off-by: Mariano Benítez Mulet <[email protected]> * Learned how to wipe the storage adapter from the registry Signed-off-by: Mariano Benítez Mulet <[email protected]> * Learned how to wipe the storage adapter from the registry Signed-off-by: Mariano Benítez Mulet <[email protected]> Co-authored-by: Mariano Benítez Mulet <[email protected]>
PromPHP · Apr 12, 2022 · 1088114 · 1088114
1 parent 0f7f022
commit 1088114
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/src/Prometheus/CollectorRegistry.php b/src/Prometheus/CollectorRegistry.php
@@ -68,6 +68,16 @@ public static function getDefault(): CollectorRegistry
         return self::$defaultRegistry ?? (self::$defaultRegistry = new self(new Redis()));  /** @phpstan-ignore-line */
     }
 
+    /**
+     * Removes all previously stored metrics from underlying storage adapter
+     *
+     * @return void
+     */
+    public function wipeStorage(): void
+    {
+        $this->storageAdapter->wipeStorage();
+    }
+
     /**
      * @return MetricFamilySamples[]
      */

diff --git a/src/Prometheus/RegistryInterface.php b/src/Prometheus/RegistryInterface.php
@@ -7,6 +7,13 @@
 
 interface RegistryInterface
 {
+    /**
+     * Removes all previously stored metrics from underlying storage adapter
+     *
+     * @return void
+     */
+    public function wipeStorage(): void;
+
     /**
      * @return MetricFamilySamples[]
      */

diff --git a/tests/Test/Prometheus/AbstractCollectorRegistryTest.php b/tests/Test/Prometheus/AbstractCollectorRegistryTest.php
@@ -418,6 +418,23 @@ public function itShouldThrowAnExceptionOnInvalidMetricLabelDataProvider(): arra
         ];
     }
 
+    /**
+     * @test
+     */
+    public function itShouldWipeTheUnderlyingStorageAdapterWhenInvokingWipeStorageMethod(): void
+    {
+        // Arrange
+        $registry = new CollectorRegistry($this->adapter);
+        $registry->registerCounter("foo", "myCounter", "Help text");
+        $registry->registerGauge("foo", "myGauge", "Help text");
+        $registry->registerHistogram("foo", "myHistogram", "Help text");
+
+        // Act
+        $registry->wipeStorage();
+
+        // Assert
+        self::assertEmpty($registry->getMetricFamilySamples());
+    }
 
     abstract public function configureAdapter(): void;
 }