Skip to content

Commit 3c5ed37

Browse files
akurov-lamscaytrase
akurov-lam
authored and
scaytrase
committed
add redis storage
1 parent e095104 commit 3c5ed37

10 files changed

+580
-0
lines changed

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* [Telegraf `JSON`](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/httpjson)
1414
* [Prometheus exporter](https://prometheus.io/docs/instrumenting/writing_exporters/)
1515
* Symfony bundle [optional]
16+
* Doctrine and redis/predis integration out of the box
1617

1718
## Installation
1819

‎composer.json

+2
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,13 @@
1616
},
1717
"require-dev": {
1818
"ext-json": "*",
19+
"ext-redis": "*",
1920
"doctrine/common": "^2.4.1 || ^3.0",
2021
"doctrine/dbal": "^2.3",
2122
"doctrine/doctrine-bundle": "~1.5 || ^2.0",
2223
"doctrine/orm": "~2.4",
2324
"phpunit/phpunit": "^7.0 || ^8.0 || ^9.0",
25+
"predis/predis": "^1.1",
2426
"symfony/browser-kit": "~2.8 || ~3.0 || ~4.0 || ^5.0",
2527
"symfony/config": "~2.8 || ~3.0 || ~4.0 || ^5.0",
2628
"symfony/dependency-injection": "~2.8 || ~3.0 || ~4.0 || ^5.0",

‎src/Adapters/Redis/AbstractRedisStorage.php

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Lamoda\Metric\Adapters\Redis;
6+
7+
use Lamoda\Metric\Common\MetricSourceInterface;
8+
use Lamoda\Metric\Storage\MetricStorageInterface;
9+
use Lamoda\Metric\Storage\MutableMetricInterface;
10+
11+
abstract class AbstractRedisStorage implements \IteratorAggregate, MetricStorageInterface
12+
{
13+
/** @var RedisConnectionInterface */
14+
private $redisConnection;
15+
16+
public function __construct(RedisConnectionInterface $redisConnection)
17+
{
18+
$this->redisConnection = $redisConnection;
19+
}
20+
21+
/** {@inheritdoc} */
22+
final public function getIterator(): \Traversable
23+
{
24+
return $this->getMetrics();
25+
}
26+
27+
/** {@inheritdoc} */
28+
final public function receive(MetricSourceInterface $source): void
29+
{
30+
$metrics = [];
31+
foreach ($source->getMetrics() as $metric) {
32+
$metrics[] = new MetricDto(
33+
$metric->getName(),
34+
$metric->resolve(),
35+
$metric->getTags()
36+
);
37+
}
38+
$this->redisConnection->setMetrics($metrics);
39+
}
40+
41+
/** {@inheritdoc} */
42+
final public function getMetrics(): \Traversable
43+
{
44+
$metricsData = $this->redisConnection->getAllMetrics();
45+
foreach ($metricsData as $metricDto) {
46+
yield new MetricWrapper(
47+
$this->redisConnection,
48+
$this->doCreateMetric($metricDto->name, $metricDto->value, $metricDto->tags)
49+
);
50+
}
51+
}
52+
53+
/** {@inheritdoc} */
54+
final public function findMetric(string $name, array $tags = []): ?MutableMetricInterface
55+
{
56+
$value = $this->redisConnection->getMetricValue($name, $tags);
57+
if ($value === null) {
58+
return null;
59+
}
60+
61+
return new MetricWrapper(
62+
$this->redisConnection,
63+
$this->doCreateMetric($name, $value, $tags)
64+
);
65+
}
66+
67+
/** {@inheritdoc} */
68+
final public function createMetric(string $name, float $value, array $tags = []): MutableMetricInterface
69+
{
70+
$metric = new MetricWrapper(
71+
$this->redisConnection,
72+
$this->doCreateMetric($name, 0, $tags)
73+
);
74+
$metric->setValue($value);
75+
76+
return $metric;
77+
}
78+
79+
abstract protected function doCreateMetric(string $name, float $value, array $tags = []): MutableMetricInterface;
80+
81+
/** {@inheritdoc} */
82+
final public function setMetricValue(string $name, float $value, array $tags = []): void
83+
{
84+
$this->redisConnection->setMetrics([new MetricDto($name, $value, $tags)]);
85+
}
86+
87+
/** {@inheritdoc} */
88+
final public function adjustMetricValue(string $name, float $value, array $tags = []): float
89+
{
90+
return $this->redisConnection->adjustMetric($name, $value, $tags);
91+
}
92+
}

‎src/Adapters/Redis/MetricDto.php

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Lamoda\Metric\Adapters\Redis;
6+
7+
/** @internal */
8+
final class MetricDto
9+
{
10+
/** @var string */
11+
public $name;
12+
/** @var float */
13+
public $value;
14+
/** @var array */
15+
public $tags;
16+
17+
public function __construct(string $name, float $value, array $tags)
18+
{
19+
$this->name = $name;
20+
$this->value = $value;
21+
$this->tags = $tags;
22+
}
23+
}

‎src/Adapters/Redis/MetricWrapper.php

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Lamoda\Metric\Adapters\Redis;
6+
7+
use Lamoda\Metric\Storage\MutableMetricInterface;
8+
9+
/** @internal */
10+
final class MetricWrapper implements MutableMetricInterface
11+
{
12+
/** @var MutatorRedisConnectionInterface */
13+
private $redisConnection;
14+
/** @var MutableMetricInterface */
15+
private $metric;
16+
17+
public function __construct(MutatorRedisConnectionInterface $redisConnection, MutableMetricInterface $metric)
18+
{
19+
$this->redisConnection = $redisConnection;
20+
$this->metric = $metric;
21+
}
22+
23+
/** {@inheritdoc} */
24+
public function adjust(float $delta): void
25+
{
26+
$value = $this->redisConnection->adjustMetric($this->getName(), $delta, $this->getTags());
27+
$this->metric->setValue($value);
28+
}
29+
30+
/** {@inheritdoc} */
31+
public function setValue(float $value): void
32+
{
33+
$this->redisConnection->setMetrics([new MetricDto($this->getName(), $value, $this->getTags())]);
34+
$this->metric->setValue($value);
35+
}
36+
37+
/** {@inheritdoc} */
38+
public function getName(): string
39+
{
40+
return $this->metric->getName();
41+
}
42+
43+
/** {@inheritdoc} */
44+
public function resolve(): float
45+
{
46+
return $this->metric->resolve();
47+
}
48+
49+
/** {@inheritdoc} */
50+
public function getTags(): array
51+
{
52+
return $this->metric->getTags();
53+
}
54+
}

‎src/Adapters/Redis/MutatorRedisConnectionInterface.php

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Lamoda\Metric\Adapters\Redis;
6+
7+
interface MutatorRedisConnectionInterface
8+
{
9+
public function adjustMetric(string $key, float $delta, array $tags): float;
10+
11+
/**
12+
* @param MetricDto[] $metricsData
13+
*/
14+
public function setMetrics(array $metricsData): void;
15+
}

‎src/Adapters/Redis/RedisConnection.php

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Lamoda\Metric\Adapters\Redis;
6+
7+
/** @internal */
8+
final class RedisConnection implements RedisConnectionInterface
9+
{
10+
private const DEFAULT_METRICS_KEY = '__php_metrics';
11+
12+
/** @var \Predis\Client|\Redis */
13+
private $client;
14+
/** @var string */
15+
private $metricsKey;
16+
17+
/**
18+
* @param \Predis\Client|\Redis $client
19+
* @param string|null $metricsKey
20+
*/
21+
public function __construct($client, ?string $metricsKey = self::DEFAULT_METRICS_KEY)
22+
{
23+
$this->client = $client;
24+
$this->metricsKey = $metricsKey;
25+
}
26+
27+
/** {@inheritdoc} */
28+
public function getAllMetrics(): array
29+
{
30+
$rawMetricsData = $this->client->hgetall($this->metricsKey);
31+
$metrics = [];
32+
foreach ($rawMetricsData as $rawMetricData => $value) {
33+
$metricData = json_decode($rawMetricData, true);
34+
$metrics[] = new MetricDto(
35+
$metricData['name'],
36+
(float) $value,
37+
$this->convertTagsFromStorage($metricData['tags'])
38+
);
39+
}
40+
41+
return $metrics;
42+
}
43+
44+
/** {@inheritdoc} */
45+
public function adjustMetric(string $key, float $delta, array $tags): float
46+
{
47+
return (float) $this->client->hincrbyfloat($this->metricsKey, $this->buildField($key, $tags), $delta);
48+
}
49+
50+
/** {@inheritdoc} */
51+
public function setMetrics(array $metricsData): void
52+
{
53+
$fields = [];
54+
foreach ($metricsData as $metricDto) {
55+
$field = $this->buildField($metricDto->name, $metricDto->tags);
56+
$fields[$field] = $metricDto->value;
57+
}
58+
$this->client->hmset($this->metricsKey, $fields);
59+
}
60+
61+
/** {@inheritdoc} */
62+
public function getMetricValue(string $key, array $tags): ?float
63+
{
64+
$value = $this->client->hget($this->metricsKey, $this->buildField($key, $tags));
65+
if ($value === false) {
66+
return null;
67+
}
68+
69+
return (float) $value;
70+
}
71+
72+
private function buildField(string $name, array $tags)
73+
{
74+
return json_encode([
75+
'name' => $name,
76+
'tags' => $this->convertTagsForStorage($tags),
77+
]);
78+
}
79+
80+
private function convertTagsForStorage(array $tags): string
81+
{
82+
return json_encode($this->normalizeTags($tags));
83+
}
84+
85+
private function convertTagsFromStorage(string $tags): array
86+
{
87+
return json_decode($tags, true);
88+
}
89+
90+
private function normalizeTags(array $tags): array
91+
{
92+
ksort($tags);
93+
94+
return $tags;
95+
}
96+
97+
}

‎src/Adapters/Redis/RedisConnectionInterface.php

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
namespace Lamoda\Metric\Adapters\Redis;
4+
5+
/** @internal */
6+
interface RedisConnectionInterface extends MutatorRedisConnectionInterface
7+
{
8+
/**
9+
* @return MetricDto[]
10+
*/
11+
public function getAllMetrics(): array;
12+
13+
public function getMetricValue(string $key, array $tags): ?float;
14+
}

0 commit comments

Comments
 (0)