Merge 5c2dc632b1 into a581a2b145

README.md

@@ -48,6 +48,7 @@ PROMETHEUS_STORAGE_ADAPTER=memory
 REDIS_HOST=localhost
 REDIS_PORT=6379
 PROMETHEUS_REDIS_PREFIX=PROMETHEUS_
+PROMETHEUS_REDIS_DATABASE=0
 ```
 
 To customize the configuration file, publish the package configuration using Artisan.

config/prometheus.php

@@ -99,6 +99,7 @@ return [
             'read_timeout' => 10,
             'persistent_connections' => false,
             'prefix' => env('PROMETHEUS_REDIS_PREFIX', 'PROMETHEUS_'),
+            'database'  =>  env('PROMETHEUS_REDIS_DATABASE', 0)
         ],
 
     ],

src/Storage/Redis.php

@@ -0,0 +1,355 @@
+<?php
+
+namespace Superbalist\LaravelPrometheusExporter\Storage;
+
+use Prometheus\Storage\Adapter;
+use Prometheus\Counter;
+use Prometheus\Exception\StorageException;
+use Prometheus\Gauge;
+use Prometheus\Histogram;
+use Prometheus\MetricFamilySamples;
+
+class Redis implements Adapter
+{
+    const PROMETHEUS_METRIC_KEYS_SUFFIX = '_METRIC_KEYS';
+
+    private static $defaultOptions = array();
+    private static $prefix = 'PROMETHEUS_';
+
+    private $options;
+    private $redis;
+
+    public function __construct(array $options = array())
+    {
+        // with php 5.3 we cannot initialize the options directly on the field definition
+        // so we initialize them here for now
+        if (!isset(self::$defaultOptions['host'])) {
+            self::$defaultOptions['host'] = '127.0.0.1';
+        }
+        if (!isset(self::$defaultOptions['port'])) {
+            self::$defaultOptions['port'] = 6379;
+        }
+        if (!isset(self::$defaultOptions['timeout'])) {
+            self::$defaultOptions['timeout'] = 0.1; // in seconds
+        }
+        if (!isset(self::$defaultOptions['read_timeout'])) {
+            self::$defaultOptions['read_timeout'] = 10; // in seconds
+        }
+        if (!isset(self::$defaultOptions['persistent_connections'])) {
+            self::$defaultOptions['persistent_connections'] = false;
+        }
+        if (!isset(self::$defaultOptions['password'])) {
+            self::$defaultOptions['password'] = null;
+        }
+
+        $this->options = array_merge(self::$defaultOptions, $options);
+        $this->redis = new \Redis();
+    }
+
+    /**
+     * @param array $options
+     */
+    public static function setDefaultOptions(array $options)
+    {
+        self::$defaultOptions = array_merge(self::$defaultOptions, $options);
+    }
+
+    public static function setPrefix($prefix)
+    {
+        self::$prefix = $prefix;
+    }
+
+    public function flushRedis()
+    {
+        $this->openConnection();
+        $this->redis->flushAll();
+    }
+
+    /**
+     * @return MetricFamilySamples[]
+     * @throws StorageException
+     */
+    public function collect()
+    {
+        $this->openConnection();
+        $metrics = $this->collectHistograms();
+        $metrics = array_merge($metrics, $this->collectGauges());
+        $metrics = array_merge($metrics, $this->collectCounters());
+        return array_map(
+            function (array $metric) {
+                return new MetricFamilySamples($metric);
+            },
+            $metrics
+        );
+    }
+
+    /**
+     * @throws StorageException
+     */
+    private function openConnection()
+    {
+        try {
+            if ($this->options['persistent_connections']) {
+                @$this->redis->pconnect($this->options['host'], $this->options['port'], $this->options['timeout']);
+            } else {
+                @$this->redis->connect($this->options['host'], $this->options['port'], $this->options['timeout']);
+            }
+            if ($this->options['password']) {
+                $this->redis->auth($this->options['password']);
+            }
+            $this->redis->setOption(\Redis::OPT_READ_TIMEOUT, $this->options['read_timeout']);
+            if(isset($this->options['database'])) {
+                $this->redis->select( (int) $this->options['database'] );
+            }
+        } catch (\RedisException $e) {
+            throw new StorageException("Can't connect to Redis server", 0, $e);
+        }
+    }
+
+    public function updateHistogram(array $data)
+    {
+        $this->openConnection();
+        $bucketToIncrease = '+Inf';
+        foreach ($data['buckets'] as $bucket) {
+            if ($data['value'] <= $bucket) {
+                $bucketToIncrease = $bucket;
+                break;
+            }
+        }
+        $metaData = $data;
+        unset($metaData['value']);
+        unset($metaData['labelValues']);
+        $this->redis->eval(<<<LUA
+local increment = redis.call('hIncrByFloat', KEYS[1], KEYS[2], ARGV[1])
+redis.call('hIncrBy', KEYS[1], KEYS[3], 1)
+if increment == ARGV[1] then
+    redis.call('hSet', KEYS[1], '__meta', ARGV[2])
+    redis.call('sAdd', KEYS[4], KEYS[1])
+end
+LUA
+            ,
+            array(
+                $this->toMetricKey($data),
+                json_encode(array('b' => 'sum', 'labelValues' => $data['labelValues'])),
+                json_encode(array('b' => $bucketToIncrease, 'labelValues' => $data['labelValues'])),
+                self::$prefix . Histogram::TYPE . self::PROMETHEUS_METRIC_KEYS_SUFFIX,
+                $data['value'],
+                json_encode($metaData),
+            ),
+            4
+        );
+    }
+
+    public function updateGauge(array $data)
+    {
+        $this->openConnection();
+        $metaData = $data;
+        unset($metaData['value']);
+        unset($metaData['labelValues']);
+        unset($metaData['command']);
+        $this->redis->eval(<<<LUA
+local result = redis.call(KEYS[2], KEYS[1], KEYS[4], ARGV[1])
+
+if KEYS[2] == 'hSet' then
+    if result == 1 then
+        redis.call('hSet', KEYS[1], '__meta', ARGV[2])
+        redis.call('sAdd', KEYS[3], KEYS[1])
+    end
+else
+    if result == ARGV[1] then
+        redis.call('hSet', KEYS[1], '__meta', ARGV[2])
+        redis.call('sAdd', KEYS[3], KEYS[1])
+    end
+end
+LUA
+            ,
+            array(
+                $this->toMetricKey($data),
+                $this->getRedisCommand($data['command']),
+                self::$prefix . Gauge::TYPE . self::PROMETHEUS_METRIC_KEYS_SUFFIX,
+                json_encode($data['labelValues']),
+                $data['value'],
+                json_encode($metaData),
+            ),
+            4
+        );
+    }
+
+    public function updateCounter(array $data)
+    {
+        $this->openConnection();
+        $metaData = $data;
+        unset($metaData['value']);
+        unset($metaData['labelValues']);
+        unset($metaData['command']);
+        $result = $this->redis->eval(<<<LUA
+local result = redis.call(KEYS[2], KEYS[1], KEYS[4], ARGV[1])
+if result == tonumber(ARGV[1]) then
+    redis.call('hMSet', KEYS[1], '__meta', ARGV[2])
+    redis.call('sAdd', KEYS[3], KEYS[1])
+end
+return result
+LUA
+            ,
+            array(
+                $this->toMetricKey($data),
+                $this->getRedisCommand($data['command']),
+                self::$prefix . Counter::TYPE . self::PROMETHEUS_METRIC_KEYS_SUFFIX,
+                json_encode($data['labelValues']),
+                $data['value'],
+                json_encode($metaData),
+            ),
+            4
+        );
+        return $result;
+    }
+
+    private function collectHistograms()
+    {
+        $keys = $this->redis->sMembers(self::$prefix . Histogram::TYPE . self::PROMETHEUS_METRIC_KEYS_SUFFIX);
+        sort($keys);
+        $histograms = array();
+        foreach ($keys as $key) {
+            $raw = $this->redis->hGetAll($key);
+            $histogram = json_decode($raw['__meta'], true);
+            unset($raw['__meta']);
+            $histogram['samples'] = array();
+
+            // Add the Inf bucket so we can compute it later on
+            $histogram['buckets'][] = '+Inf';
+
+            $allLabelValues = array();
+            foreach (array_keys($raw) as $k) {
+                $d = json_decode($k, true);
+                if ($d['b'] == 'sum') {
+                    continue;
+                }
+                $allLabelValues[] = $d['labelValues'];
+            }
+
+            // We need set semantics.
+            // This is the equivalent of array_unique but for arrays of arrays.
+            $allLabelValues = array_map("unserialize", array_unique(array_map("serialize", $allLabelValues)));
+            sort($allLabelValues);
+
+            foreach ($allLabelValues as $labelValues) {
+                // Fill up all buckets.
+                // If the bucket doesn't exist fill in values from
+                // the previous one.
+                $acc = 0;
+                foreach ($histogram['buckets'] as $bucket) {
+                    $bucketKey = json_encode(array('b' => $bucket, 'labelValues' => $labelValues));
+                    if (!isset($raw[$bucketKey])) {
+                        $histogram['samples'][] = array(
+                            'name' => $histogram['name'] . '_bucket',
+                            'labelNames' => array('le'),
+                            'labelValues' => array_merge($labelValues, array($bucket)),
+                            'value' => $acc
+                        );
+                    } else {
+                        $acc += $raw[$bucketKey];
+                        $histogram['samples'][] = array(
+                            'name' => $histogram['name'] . '_bucket',
+                            'labelNames' => array('le'),
+                            'labelValues' => array_merge($labelValues, array($bucket)),
+                            'value' => $acc
+                        );
+                    }
+                }
+
+                // Add the count
+                $histogram['samples'][] = array(
+                    'name' => $histogram['name'] . '_count',
+                    'labelNames' => array(),
+                    'labelValues' => $labelValues,
+                    'value' => $acc
+                );
+
+                // Add the sum
+                $histogram['samples'][] = array(
+                    'name' => $histogram['name'] . '_sum',
+                    'labelNames' => array(),
+                    'labelValues' => $labelValues,
+                    'value' => $raw[json_encode(array('b' => 'sum', 'labelValues' => $labelValues))]
+                );
+            }
+            $histograms[] = $histogram;
+        }
+        return $histograms;
+    }
+
+    private function collectGauges()
+    {
+        $keys = $this->redis->sMembers(self::$prefix . Gauge::TYPE . self::PROMETHEUS_METRIC_KEYS_SUFFIX);
+        sort($keys);
+        $gauges = array();
+        foreach ($keys as $key) {
+            $raw = $this->redis->hGetAll($key);
+            $gauge = json_decode($raw['__meta'], true);
+            unset($raw['__meta']);
+            $gauge['samples'] = array();
+            foreach ($raw as $k => $value) {
+                $gauge['samples'][] = array(
+                    'name' => $gauge['name'],
+                    'labelNames' => array(),
+                    'labelValues' => json_decode($k, true),
+                    'value' => $value
+                );
+            }
+            usort($gauge['samples'], function($a, $b){
+                return strcmp(implode("", $a['labelValues']), implode("", $b['labelValues']));
+            });
+            $gauges[] = $gauge;
+        }
+        return $gauges;
+    }
+
+    private function collectCounters()
+    {
+        $keys = $this->redis->sMembers(self::$prefix . Counter::TYPE . self::PROMETHEUS_METRIC_KEYS_SUFFIX);
+        sort($keys);
+        $counters = array();
+        foreach ($keys as $key) {
+            $raw = $this->redis->hGetAll($key);
+            $counter = json_decode($raw['__meta'], true);
+            unset($raw['__meta']);
+            $counter['samples'] = array();
+            foreach ($raw as $k => $value) {
+                $counter['samples'][] = array(
+                    'name' => $counter['name'],
+                    'labelNames' => array(),
+                    'labelValues' => json_decode($k, true),
+                    'value' => $value
+                );
+            }
+            usort($counter['samples'], function($a, $b){
+                return strcmp(implode("", $a['labelValues']), implode("", $b['labelValues']));
+            });
+            $counters[] = $counter;
+        }
+        return $counters;
+    }
+
+    private function getRedisCommand($cmd)
+    {
+        switch ($cmd) {
+            case Adapter::COMMAND_INCREMENT_INTEGER:
+                return 'hIncrBy';
+            case Adapter::COMMAND_INCREMENT_FLOAT:
+                return 'hIncrByFloat';
+            case Adapter::COMMAND_SET:
+                return 'hSet';
+            default:
+                throw new \InvalidArgumentException("Unknown command");
+        }
+    }
+
+    /**
+     * @param array $data
+     * @return string
+     */
+    private function toMetricKey(array $data)
+    {
+        return implode(':', array(self::$prefix, $data['type'], $data['name']));
+    }
+}

src/StorageAdapterFactory.php

@@ -6,7 +6,7 @@ use InvalidArgumentException;
 use Prometheus\Storage\Adapter;
 use Prometheus\Storage\APC;
 use Prometheus\Storage\InMemory;
-use Prometheus\Storage\Redis;
+use Superbalist\LaravelPrometheusExporter\Storage\Redis;
 
 class StorageAdapterFactory
 {

tests/StorageAdapterFactoryTest.php

@@ -5,7 +5,7 @@ namespace Tests;
 use PHPUnit\Framework\TestCase;
 use Prometheus\Storage\APC;
 use Prometheus\Storage\InMemory;
-use Prometheus\Storage\Redis;
+use Superbalist\LaravelPrometheusExporter\Storage\Redis;
 use Superbalist\LaravelPrometheusExporter\StorageAdapterFactory;
 
 class StorageAdapterFactoryTest extends TestCase