Merge pull request #36 from krukru/InMemory-impl

In memory impl

Author: bracki

README.md

@@ -10,9 +10,9 @@ If using Redis, we recommend to run a local Redis instance next to your PHP work
 ## How does it work?
 
 Usually PHP worker processes don't share any state.
-You can pick from two adapters.
-One uses Redis the other APC.
-While the former needs a separate binary running, the latter just needs the [APC](https://pecl.php.net/package/APCU) extension to be installed.
+You can pick from three adapters.
+Redis, APC or an in memory adapter.
+While the first needs a separate binary running, the second just needs the [APC](https://pecl.php.net/package/APCU) extension to be installed. If you don't need persistent metrics between requests (e.g. a long running cron job or script) the in memory adapter might be suitable to use.
 
 ## Usage
 
@@ -73,6 +73,17 @@ Change the Redis options (the example shows the defaults):
 );
 ```
 
+Using the InMemory storage:
+```php
+$registry = new CollectorRegistry(new InMemory());
+
+$counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);
+$counter->incBy(3, ['blue']);
+
+$renderer = new RenderTextFormat();
+$result = $renderer->render($registry->getMetricFamilySamples());
+```
+
 Also look at the [examples](examples).
 
 ## Development

examples/flush_adapter.php

@@ -3,14 +3,15 @@
 
 $adapter = $_GET['adapter'];
 
-if ($adapter == 'redis') {
+if ($adapter === 'redis') {
     define('REDIS_HOST', isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1');
 
     $redisAdapter = new Prometheus\Storage\Redis(array('host' => REDIS_HOST));
     $redisAdapter->flushRedis();
-}
-
-if ($adapter == 'apc') {
+} elseif ($adapter === 'apc') {
     $apcAdapter = new Prometheus\Storage\APC();
     $apcAdapter->flushAPC();
-}
+} elseif ($adapter === 'in-memory') {
+    $inMemoryAdapter = new Prometheus\Storage\InMemory();
+    $inMemoryAdapter->flushMemory();
+}

examples/metrics.php

@@ -8,12 +8,13 @@
 
 $adapter = $_GET['adapter'];
 
-if ($adapter == 'redis') {
+if ($adapter === 'redis') {
     Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
     $adapter = new Prometheus\Storage\Redis();
-}
-if ($adapter == 'apc') {
+} elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();
+} elseif ($adapter === 'in-memory') {
+    $adapter = new Prometheus\Storage\InMemory();
 }
 $registry = new CollectorRegistry($adapter);
 $renderer = new RenderTextFormat();

examples/pushgateway.php

@@ -1,9 +1,20 @@
 <?php
 require __DIR__ . '/../vendor/autoload.php';
 
+use Prometheus\Storage\Redis;
 use Prometheus\CollectorRegistry;
 
-$adapter = new Prometheus\Storage\APC();
+$adapter = $_GET['adapter'];
+
+if ($adapter === 'redis') {
+    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    $adapter = new Prometheus\Storage\Redis();
+} elseif ($adapter === 'apc') {
+    $adapter = new Prometheus\Storage\APC();
+} elseif ($adapter === 'in-memory') {
+    $adapter = new Prometheus\Storage\InMemory();
+}
+
 $registry = new CollectorRegistry($adapter);
 
 $counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);

examples/some_counter.php

@@ -5,16 +5,15 @@
 use Prometheus\CollectorRegistry;
 use Prometheus\Storage\Redis;
 
-error_log('c='. $_GET['c']);
-
 $adapter = $_GET['adapter'];
 
-if ($adapter == 'redis') {
+if ($adapter === 'redis') {
     Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
     $adapter = new Prometheus\Storage\Redis();
-}
-if ($adapter == 'apc') {
+} elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();
+} elseif ($adapter === 'in-memory') {
+    $adapter = new Prometheus\Storage\InMemory();
 }
 $registry = new CollectorRegistry($adapter);
 

examples/some_gauge.php

@@ -10,12 +10,13 @@
 
 $adapter = $_GET['adapter'];
 
-if ($adapter == 'redis') {
+if ($adapter === 'redis') {
     Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
     $adapter = new Prometheus\Storage\Redis();
-}
-if ($adapter == 'apc') {
+} elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();
+} elseif ($adapter === 'in-memory') {
+    $adapter = new Prometheus\Storage\InMemory();
 }
 $registry = new CollectorRegistry($adapter);
 

examples/some_histogram.php

@@ -9,12 +9,13 @@
 
 $adapter = $_GET['adapter'];
 
-if ($adapter == 'redis') {
+if ($adapter === 'redis') {
     Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
     $adapter = new Prometheus\Storage\Redis();
-}
-if ($adapter == 'apc') {
+} elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();
+} elseif ($adapter === 'in-memory') {
+    $adapter = new Prometheus\Storage\InMemory();
 }
 $registry = new CollectorRegistry($adapter);