Added support of Predis library as storage adapter #127
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Prometheus\Storage; | ||
|
|
||
| use Predis\Configuration\Option\Prefix; | ||
| use Prometheus\Exception\StorageException; | ||
| use Predis\Client; | ||
|
|
||
| /** | ||
| * @property Client $redis | ||
| */ | ||
| final class Predis extends Redis | ||
| { | ||
| /** | ||
| * @var mixed[] | ||
| */ | ||
| private static array $defaultOptions = [ | ||
| 'host' => '127.0.0.1', | ||
| 'port' => 6379, | ||
| 'scheme' => 'tcp', | ||
| 'timeout' => 0.1, | ||
| 'read_timeout' => '10', | ||
| 'persistent' => 0, | ||
| 'password' => null, | ||
| ]; | ||
|
|
||
| public function __construct(array $options = []) | ||
| { | ||
| $this->options = array_merge(self::$defaultOptions, $options); | ||
|
|
||
| parent::__construct($options); | ||
|
|
||
| $this->redis = new Client($this->options); | ||
| } | ||
|
|
||
| public static function fromClient(Client $redis): self | ||
| { | ||
| if ($redis->isConnected() === false) { | ||
| throw new StorageException('Connection to Redis server not established'); | ||
| } | ||
|
|
||
| $self = new self(); | ||
| $self->redis = $redis; | ||
|
|
||
| return $self; | ||
| } | ||
|
|
||
| protected function ensureOpenConnection(): void | ||
| { | ||
| if ($this->redis->isConnected() === false) { | ||
| $this->redis->connect(); | ||
| } | ||
| } | ||
|
|
||
| public static function fromExistingConnection(\Redis $redis): Redis | ||
| { | ||
| throw new \RuntimeException('This method is not supported by predis adapter'); | ||
| } | ||
|
|
||
| protected function getGlobalPrefix(): ?string | ||
| { | ||
| if ($this->redis->getOptions()->prefix === null) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($this->redis->getOptions()->prefix instanceof Prefix) { | ||
| return $this->redis->getOptions()->prefix->getPrefix(); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * @param mixed[] $args | ||
| * @param int $keysCount | ||
| * @return mixed[] | ||
| */ | ||
| protected function evalParams(array $args, int $keysCount): array | ||
| { | ||
| return [$keysCount, ...$args]; | ||
| } | ||
|
|
||
|
|
||
| protected function prefix(string $key): string | ||
| { | ||
| // the predis is doing key prefixing on its own | ||
| return ''; | ||
| } | ||
|
|
||
| protected function setParams(array $input): array | ||
| { | ||
| $values = array_values($input); | ||
| $params = []; | ||
|
|
||
| if (isset($input['EX'])) { | ||
| $params[] = 'EX'; | ||
| $params[] = $input['EX']; | ||
| } | ||
|
|
||
| if (isset($input['PX'])) { | ||
| $params[] = 'PX'; | ||
| $params[] = $input['PX']; | ||
| } | ||
|
|
||
| $params[] = $values[0]; | ||
|
|
||
| return $params; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Test\Prometheus\Predis; | ||
|
|
||
| use Predis\Client; | ||
| use Prometheus\Storage\Predis; | ||
| use Test\Prometheus\AbstractCollectorRegistryTest; | ||
|
|
||
| /** | ||
| * @requires predis | ||
| */ | ||
| class CollectorRegistryTest extends AbstractCollectorRegistryTest | ||
| { | ||
| public function configureAdapter(): void | ||
| { | ||
| $this->adapter = new Predis(['host' => REDIS_HOST]); | ||
| $this->adapter->wipeStorage(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Test\Prometheus\Predis; | ||
|
|
||
| use Predis\Client; | ||
| use Prometheus\Storage\Predis; | ||
| use Test\Prometheus\AbstractCounterTest; | ||
|
|
||
| /** | ||
| * See https://prometheus.io/docs/instrumenting/exposition_formats/ | ||
| * @requires extension redis | ||
| */ | ||
| class CounterTest extends AbstractCounterTest | ||
| { | ||
| public function configureAdapter(): void | ||
| { | ||
| $this->adapter = new Predis(['host' => REDIS_HOST]); | ||
| $this->adapter->wipeStorage(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.