├── .gitignore
├── Api
    ├── Data
    │   ├── RedisReportInterface.php
    │   └── RedisReportSearchResultsInterface.php
    └── RedisReportRepositoryInterface.php
├── Controller
    └── Adminhtml
    │   └── Index
    │       └── Index.php
├── Cron
    ├── Clean.php
    └── Log.php
├── LICENSE
├── Model
    ├── RedisInfo.php
    ├── RedisReport.php
    ├── RedisReportRepository.php
    └── ResourceModel
    │   ├── RedisReport.php
    │   └── RedisReport
    │       └── Collection.php
├── README.md
├── Scope
    └── Config.php
├── composer.json
├── etc
    ├── acl.xml
    ├── adminhtml
    │   ├── menu.xml
    │   ├── routes.xml
    │   └── system.xml
    ├── config.xml
    ├── crontab.xml
    ├── db_schema.xml
    ├── di.xml
    └── module.xml
├── registration.php
└── view
    └── adminhtml
        ├── layout
            └── redis_report_index_index.xml
        ├── templates
            ├── info
            │   ├── activity.phtml
            │   ├── connections.phtml
            │   ├── databases.phtml
            │   └── memory.phtml
            └── wrapper.phtml
        └── web
            ├── css
                └── module.css
            └── js
                └── chart.js


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | node_modules/
3 | 


--------------------------------------------------------------------------------
/Api/Data/RedisReportInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Api\Data;
 9 | 
10 | interface RedisReportInterface
11 | {
12 |     public const ENTITY_ID = 'entity_id';
13 |     public const REPORT_DATA = 'report_data';
14 |     public const CHART_DATA = 'chart_data';
15 |     public const CREATED_AT = 'created_at';
16 |     public const UPDATED_AT = 'updated_at';
17 | 
18 |     /**
19 |      * @return int
20 |      */
21 |     public function getEntityId(): int;
22 | 
23 |     /**
24 |      * @param int|string $entityId
25 |      * @return self
26 |      */
27 |     public function setEntityId($entityId): self;
28 | 
29 |     /**
30 |      * @return array
31 |      */
32 |     public function getReportData(): array;
33 | 
34 |     /**
35 |      * @param array $reportData
36 |      * @return self
37 |      */
38 |     public function setReportData(array $reportData): self;
39 | 
40 |     /**
41 |      * @return array
42 |      */
43 |     public function getChartData(): array;
44 | 
45 |     /**
46 |      * @param array $chartData
47 |      * @return self
48 |      */
49 |     public function setChartData(array $chartData): self;
50 | 
51 |     /**
52 |      * @return string
53 |      */
54 |     public function getCreatedAt(): string;
55 | 
56 |     /**
57 |      * @param string $createdAt
58 |      * @return self
59 |      */
60 |     public function setCreatedAt(string $createdAt): self;
61 | 
62 |     /**
63 |      * @return string
64 |      */
65 |     public function getUpdatedAt(): string;
66 | 
67 |     /**
68 |      * @param string $updatedAt
69 |      * @return self
70 |      */
71 |     public function setUpdatedAt(string $updatedAt): self;
72 | }
73 | 


--------------------------------------------------------------------------------
/Api/Data/RedisReportSearchResultsInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Api\Data;
 9 | 
10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
11 | use Magento\Framework\Api\SearchResultsInterface;
12 | 
13 | interface RedisReportSearchResultsInterface extends SearchResultsInterface
14 | {
15 |     /**
16 |      * @return RedisReportInterface[]
17 |      */
18 |     public function getItems(): array;
19 | 
20 |     /**
21 |      * @param RedisReportInterface[] $items
22 |      * @return self
23 |      */
24 |     public function setItems(array $items): self;
25 | }
26 | 


--------------------------------------------------------------------------------
/Api/RedisReportRepositoryInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Api;
 9 | 
10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
11 | use Magento\Framework\Api\SearchCriteriaInterface;
12 | use Magento\Framework\Api\SearchResults;
13 | use Magento\Framework\Exception\CouldNotDeleteException;
14 | use Magento\Framework\Exception\CouldNotSaveException;
15 | use Magento\Framework\Exception\NoSuchEntityException;
16 | 
17 | interface RedisReportRepositoryInterface
18 | {
19 |     public const MAIN_TABLE = 'e119_redis_report';
20 | 
21 |     /**
22 |      * @param RedisReportInterface $redisReport
23 |      * @return RedisReportInterface
24 |      * @throws CouldNotSaveException
25 |      */
26 |     public function save(RedisReportInterface $redisReport): RedisReportInterface;
27 | 
28 |     /**
29 |      * @param int $redisReportId
30 |      * @return RedisReportInterface
31 |      * @throws NoSuchEntityException
32 |      */
33 |     public function getById(int $redisReportId): RedisReportInterface;
34 | 
35 |     /**
36 |      * @param SearchCriteriaInterface $searchCriteria
37 |      * @return SearchResults
38 |      */
39 |     public function getList(SearchCriteriaInterface $searchCriteria): SearchResults;
40 | 
41 |     /**
42 |      * @param RedisReportInterface $redisReport
43 |      * @return bool true on success
44 |      * @throws CouldNotDeleteException
45 |      */
46 |     public function delete(RedisReportInterface $redisReport): bool;
47 | 
48 |     /**
49 |      * @param int $redisReportId
50 |      * @return bool true on success
51 |      * @throws NoSuchEntityException
52 |      * @throws CouldNotDeleteException
53 |      */
54 |     public function deleteById(int $redisReportId): bool;
55 | }
56 | 


--------------------------------------------------------------------------------
/Controller/Adminhtml/Index/Index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Controller\Adminhtml\Index;
 9 | 
10 | use Magento\Backend\App\Action;
11 | use Magento\Backend\App\Action\Context;
12 | use Magento\Framework\View\Result\Page;
13 | use Magento\Framework\View\Result\PageFactory;
14 | 
15 | class Index extends Action
16 | {
17 |     public const ADMIN_RESOURCE = 'Element119_AdminRedisReport::view';
18 | 
19 |     private PageFactory $resultPageFactory;
20 | 
21 |     public function __construct(
22 |         Context $context,
23 |         PageFactory $resultPageFactory
24 |     ) {
25 |         parent::__construct($context);
26 | 
27 |         $this->resultPageFactory = $resultPageFactory;
28 |     }
29 | 
30 |     public function execute(): Page
31 |     {
32 |         $resultPage = $this->resultPageFactory->create();
33 |         $resultPage->getConfig()->getTitle()->prepend(__('Redis Report'));
34 | 
35 |         return $resultPage;
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/Cron/Clean.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Cron;
 9 | 
10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
11 | use Element119\AdminRedisReport\Api\RedisReportRepositoryInterface;
12 | use Element119\AdminRedisReport\Scope\Config;
13 | use Exception;
14 | use Magento\Framework\Api\SearchCriteriaBuilder;
15 | use Magento\Framework\Api\SearchCriteriaBuilderFactory;
16 | use Magento\Framework\Exception\CouldNotDeleteException;
17 | use Magento\Framework\Intl\DateTimeFactory;
18 | use Magento\Framework\Stdlib\DateTime;
19 | 
20 | class Clean
21 | {
22 |     private RedisReportRepositoryInterface $redisReportRepository;
23 |     private Config $moduleConfig;
24 |     private SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory;
25 |     private DateTimeFactory $dateTimeFactory;
26 | 
27 |     public function __construct(
28 |         RedisReportRepositoryInterface $redisReportRepository,
29 |         Config $moduleConfig,
30 |         SearchCriteriaBuilderFactory $searchCriteriaBuilderFactory,
31 |         DateTimeFactory $dateTimeFactory
32 |     ) {
33 |         $this->redisReportRepository = $redisReportRepository;
34 |         $this->moduleConfig = $moduleConfig;
35 |         $this->searchCriteriaBuilderFactory = $searchCriteriaBuilderFactory;
36 |         $this->dateTimeFactory = $dateTimeFactory;
37 |     }
38 | 
39 |     /**
40 |      * Delete old Redis report data.
41 |      *
42 |      * @return void
43 |      * @throws CouldNotDeleteException
44 |      */
45 |     public function execute(): void
46 |     {
47 |         if (!($days = $this->moduleConfig->getRedisReportLogTruncateDays())) {
48 |             return;
49 |         }
50 | 
51 |         $lastException = null;
52 | 
53 |         /** @var DateTime $cutoff */
54 |         $cutoff = $this->dateTimeFactory->create(date(DateTime::DATETIME_PHP_FORMAT, strtotime("-$days day")));
55 | 
56 |         /** @var SearchCriteriaBuilder $searchCriteriaBuilder */
57 |         $searchCriteriaBuilder = $this->searchCriteriaBuilderFactory->create();
58 |         $searchCriteria = $searchCriteriaBuilder->addFilter(
59 |             RedisReportInterface::CREATED_AT,
60 |             $cutoff,
61 |             'lt'
62 |         )->create();
63 | 
64 |         /** @var RedisReportInterface[] $redisReportsToDelete */
65 |         $redisReportsToDelete = $this->redisReportRepository->getList($searchCriteria)->getItems();
66 | 
67 |         foreach ($redisReportsToDelete as $redisReport) {
68 |             try {
69 |                 $this->redisReportRepository->delete($redisReport);
70 |             } catch (CouldNotDeleteException $e) {
71 |                 $lastException = $e; // store exception as not to stop execution
72 |             }
73 |         }
74 | 
75 |         if ($lastException instanceof Exception) {
76 |             throw $lastException; // re-throw exception to make noise
77 |         }
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/Cron/Log.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Cron;
 9 | 
10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
11 | use Element119\AdminRedisReport\Api\RedisReportRepositoryInterface;
12 | use Element119\AdminRedisReport\Model\RedisInfo;
13 | use Element119\AdminRedisReport\Model\RedisReportFactory;
14 | use Element119\AdminRedisReport\Scope\Config;
15 | use Magento\Framework\Exception\CouldNotSaveException;
16 | 
17 | class Log
18 | {
19 |     private RedisReportRepositoryInterface $redisReportRepository;
20 |     private RedisInfo $redisInfo;
21 |     private RedisReportFactory $redisReportFactory;
22 |     private Config $moduleConfig;
23 | 
24 |     public function __construct(
25 |         RedisReportRepositoryInterface $redisReportRepository,
26 |         RedisInfo $redisInfo,
27 |         RedisReportFactory $redisReportFactory,
28 |         Config $moduleConfig
29 |     ) {
30 |         $this->redisReportRepository = $redisReportRepository;
31 |         $this->redisInfo = $redisInfo;
32 |         $this->redisReportFactory = $redisReportFactory;
33 |         $this->moduleConfig = $moduleConfig;
34 |     }
35 | 
36 |     /**
37 |      * Store Redis report data.
38 |      *
39 |      * @return void
40 |      * @throws CouldNotSaveException
41 |      */
42 |     public function execute(): void
43 |     {
44 |         if (!$this->moduleConfig->isRedisReportLoggingCronEnabled()) {
45 |             return;
46 |         }
47 | 
48 |         /** @var RedisReportInterface $redisReportModel */
49 |         $redisReportModel = $this->redisReportFactory->create();
50 |         $allRedisData = $this->redisInfo->get();
51 | 
52 |         if (array_key_exists('chart-data', $allRedisData)) {
53 |             $redisReportModel->setChartData($allRedisData['chart-data']);
54 |             unset($allRedisData['chart-data']);
55 |         }
56 | 
57 |         $redisReportModel->setReportData($allRedisData);
58 |         $this->redisReportRepository->save($redisReportModel);
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2024 element119
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/Model/RedisInfo.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | namespace Element119\AdminRedisReport\Model;
  9 | 
 10 | use Cm_Cache_Backend_Redis;
 11 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
 12 | use Element119\AdminRedisReport\Api\RedisReportRepositoryInterface;
 13 | use Magento\Framework\App\CacheInterface;
 14 | use Magento\Framework\Cache\Backend\Redis;
 15 | use Magento\Framework\App\DeploymentConfig;
 16 | use Magento\Framework\App\ResourceConnection;
 17 | use Magento\Framework\View\Element\Block\ArgumentInterface;
 18 | use Zend_Db_Statement_Exception;
 19 | 
 20 | class RedisInfo implements ArgumentInterface
 21 | {
 22 |     private CacheInterface $cache;
 23 |     private DeploymentConfig $deploymentConfig;
 24 |     private ResourceConnection $resourceConnection;
 25 | 
 26 |     /** @var Redis|Cm_Cache_Backend_Redis */
 27 |     private $redis;
 28 | 
 29 |     public function __construct(
 30 |         CacheInterface $cache,
 31 |         DeploymentConfig $deploymentConfig,
 32 |         ResourceConnection $resourceConnection
 33 |     ) {
 34 |         $this->cache = $cache;
 35 |         $this->deploymentConfig = $deploymentConfig;
 36 |         $this->resourceConnection = $resourceConnection;
 37 |         $this->redis = $this->cache->getFrontend()->getBackend();
 38 |     }
 39 | 
 40 |     public function get(): array
 41 |     {
 42 |         if (!($redisInfo = $this->getAllRedisInfo())) {
 43 |             return [];
 44 |         }
 45 | 
 46 |         return [
 47 |             'version' => $redisInfo['redis_version'],
 48 |             'databases' => $this->getDatabaseKeyspaceInfo($redisInfo),
 49 |             'memory' => [
 50 |                 'Used Memory' => $redisInfo['used_memory_human'],
 51 |                 'Used Memory Peak' => $redisInfo['used_memory_peak_human'],
 52 |                 'Used Memory Peak Percentage' => $redisInfo['used_memory_peak_perc'],
 53 |                 'Used Memory Dataset Percentage' => $redisInfo['used_memory_dataset_perc'],
 54 |                 'Percentage of Keys Used by Magento' => $this->getMagentoKeyUsagePercentage($redisInfo) . '%',
 55 |                 'Total System Memory' => $redisInfo['total_system_memory_human'],
 56 |                 'Max. Memory' => $redisInfo['maxmemory_human'],
 57 |                 'Max. Memory Policy' => $redisInfo['maxmemory_policy'],
 58 |             ],
 59 |             'connections' => [
 60 |                 'Cluster Enabled' => $redisInfo['cluster_enabled'],
 61 |                 'Max. Clients' => $redisInfo['maxclients'],
 62 |                 'Connected Clients' => $redisInfo['connected_clients'],
 63 |                 'Cluster Connections' => $redisInfo['cluster_connections'],
 64 |                 'Rejected Connections' => $redisInfo['rejected_connections'],
 65 |             ],
 66 |             'activity' => [
 67 |                 'Uptime in Days' => $redisInfo['uptime_in_days'],
 68 |                 'Uptime in Seconds' => $redisInfo['uptime_in_seconds'],
 69 |                 'Keyspace Hits' => $redisInfo['keyspace_hits'],
 70 |                 'Keyspace Misses' => $redisInfo['keyspace_misses'],
 71 |                 'Hit Rate' => $this->redis->getHitMissPercentage() . '%',
 72 |                 'Total Error Replies' => $redisInfo['total_error_replies'],
 73 |                 'Evicted Keys' => $redisInfo['evicted_keys'],
 74 |                 'Expired Keys' => $redisInfo['expired_keys'],
 75 |                 'Used CPU Time (Sys)' => round((float)$redisInfo['used_cpu_sys'], 2) . ' seconds',
 76 |                 'Used CPU Time (User)' => round((float)$redisInfo['used_cpu_user'], 2) . ' seconds',
 77 |                 'RDB Last Save Time' => date('r', (int)$redisInfo['rdb_last_save_time']),
 78 |                 'RDB Changes Since Last Save' => $redisInfo['rdb_changes_since_last_save'],
 79 |                 'Total Reads Processed' => $redisInfo['total_reads_processed'],
 80 |                 'Total Writes Processed' => $redisInfo['total_writes_processed'],
 81 |             ],
 82 |             'chart-data' => [
 83 |                 'memory' => [
 84 |                     'Used Memory' => $redisInfo['used_memory'],
 85 |                     'Used Memory Peak' => $redisInfo['used_memory_peak'],
 86 |                     'Used Memory Peak Percentage' => $redisInfo['used_memory_peak_perc'],
 87 |                     'Used Memory Dataset Percentage' => $redisInfo['used_memory_dataset_perc'],
 88 |                     'Percentage of Keys Used by Magento' => $this->getMagentoKeyUsagePercentage($redisInfo),
 89 |                 ],
 90 |                 'activity' => [
 91 |                     'Keyspace Hits' => $redisInfo['keyspace_hits'],
 92 |                     'Keyspace Misses' => $redisInfo['keyspace_misses'],
 93 |                     'Hit Rate' => $this->redis->getHitMissPercentage(),
 94 |                     'Total Error Replies' => $redisInfo['total_error_replies'],
 95 |                     'Evicted Keys' => $redisInfo['evicted_keys'],
 96 |                     'Expired Keys' => $redisInfo['expired_keys'],
 97 |                     'Used CPU Time (Sys)' => round((float)$redisInfo['used_cpu_sys'], 2),
 98 |                     'Used CPU Time (User)' => round((float)$redisInfo['used_cpu_user'], 2),
 99 |                     'Total Reads Processed' => $redisInfo['total_reads_processed'],
100 |                     'Total Writes Processed' => $redisInfo['total_writes_processed'],
101 |                 ],
102 |             ],
103 |         ];
104 |     }
105 | 
106 |     public function getDatabaseKeyspaceInfo(array $redisInfo): array
107 |     {
108 |         $redisDatabaseInfo = [];
109 |         $dbKeys = preg_grep('/^db(\d*)/m', array_keys($redisInfo)); // db0, db1 ... db(n-1), db(n)
110 | 
111 |         foreach ($dbKeys as $dbKey) {
112 |             // keyspace info e.g. key count, expiring key count, and average ttl
113 |             $dbInfo = explode(',', $redisInfo[$dbKey]);
114 | 
115 |             foreach ($dbInfo as $info) {
116 |                 $data = explode('=', $info);
117 | 
118 |                 array_key_exists($dbKey, $redisDatabaseInfo)
119 |                     ? $redisDatabaseInfo[$dbKey] += [$data[0] => (int)$data[1]] // append
120 |                     : $redisDatabaseInfo[$dbKey] = [$data[0] => (int)$data[1]]; // initialise
121 |             }
122 | 
123 |             $avgTtlKey = array_key_last($redisDatabaseInfo[$dbKey]);
124 |             $redisDatabaseInfo[$dbKey][$avgTtlKey] = ($redisDatabaseInfo[$dbKey][$avgTtlKey] / 1000) . ' seconds';
125 |         }
126 | 
127 |         return $redisDatabaseInfo;
128 |     }
129 | 
130 |     public function getMagentoKeyUsagePercentage(array $redisInfo): float
131 |     {
132 |         $cacheConfig = $this->deploymentConfig->get('cache');
133 | 
134 |         if (!isset($cacheConfig['frontend']['default']['id_prefix'])) {
135 |             return -1.0;
136 |         }
137 | 
138 |         $allTags = $this->redis->getTags() + $this->redis->getIds();
139 |         $redisKeyPrefix = $cacheConfig['frontend']['default']['id_prefix'];
140 |         $tagsWithPrefix = preg_grep('/^' . preg_quote($redisKeyPrefix) . '/m', $allTags);
141 | 
142 |         return round((count($tagsWithPrefix) / count($allTags)) * 100, 2);
143 |     }
144 | 
145 |     /**
146 |      * Return historic Redis data, keyed by creation timestamp.
147 |      *
148 |      * @return array
149 |      * @throws Zend_Db_Statement_Exception
150 |      */
151 |     public function getHistoricRedisReportData(): array
152 |     {
153 |         $reportData = [];
154 |         $connection = $this->resourceConnection->getConnection();
155 |         $redisReportSelect = $connection->select()->from(
156 |             $this->resourceConnection->getTableName(RedisReportRepositoryInterface::MAIN_TABLE),
157 |             [
158 |                 RedisReportInterface::REPORT_DATA,
159 |                 RedisReportInterface::CHART_DATA,
160 |                 RedisReportInterface::CREATED_AT,
161 |             ]
162 |         );
163 | 
164 |         foreach ($connection->query($redisReportSelect)->fetchAll() as $dbData) {
165 |             $reportData[$dbData[RedisReportInterface::CREATED_AT]] = json_decode(
166 |                 $dbData[RedisReportInterface::REPORT_DATA], true
167 |             );
168 | 
169 |             if ($dbData[RedisReportInterface::CHART_DATA]) {
170 |                 $chartData = json_decode($dbData[RedisReportInterface::CHART_DATA], true);
171 |                 $chartData[RedisReportInterface::CREATED_AT] = $dbData[RedisReportInterface::CREATED_AT];
172 | 
173 |                 $reportData[$dbData[RedisReportInterface::CREATED_AT]][RedisReportInterface::CHART_DATA] = $chartData;
174 |             }
175 |         }
176 | 
177 |         return $reportData;
178 |     }
179 | 
180 |     /**
181 |      * Get all Redis information.
182 |      *
183 |      * This function exists solely to ease extensibility.
184 |      *
185 |      * @link https://redis.io/commands/info/
186 |      *
187 |      * @return array
188 |      */
189 |     public function getAllRedisInfo(): array
190 |     {
191 |         return $this->redis instanceof Cm_Cache_Backend_Redis && method_exists($this->redis, 'getInfo')
192 |             ? $this->redis->getInfo()
193 |             : [];
194 |     }
195 | }
196 | 


--------------------------------------------------------------------------------
/Model/RedisReport.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | namespace Element119\AdminRedisReport\Model;
  9 | 
 10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
 11 | use Element119\AdminRedisReport\Model\ResourceModel\RedisReport as RedisReportResourceModel;
 12 | use Magento\Framework\Model\AbstractModel;
 13 | 
 14 | class RedisReport extends AbstractModel implements RedisReportInterface
 15 | {
 16 |     /**
 17 |      * @inheritDoc
 18 |      */
 19 |     public function _construct()
 20 |     {
 21 |         $this->_init(RedisReportResourceModel::class);
 22 |     }
 23 | 
 24 |     /**
 25 |      * @inheritDoc
 26 |      */
 27 |     public function getEntityId(): int
 28 |     {
 29 |         return (int)$this->getData(self::ENTITY_ID);
 30 |     }
 31 | 
 32 |     /**
 33 |      * @inheritDoc
 34 |      */
 35 |     public function setEntityId($entityId): self
 36 |     {
 37 |         return $this->setData(self::ENTITY_ID, $entityId);
 38 |     }
 39 | 
 40 |     /**
 41 |      * @inheritDoc
 42 |      */
 43 |     public function getReportData(): array
 44 |     {
 45 |         return $this->getData(json_decode(self::REPORT_DATA));
 46 |     }
 47 | 
 48 |     /**
 49 |      * @inheritDoc
 50 |      */
 51 |     public function setReportData(array $reportData): RedisReportInterface
 52 |     {
 53 |         return $this->setData(self::REPORT_DATA, json_encode($reportData));
 54 |     }
 55 | 
 56 |     /**
 57 |      * @inheritDoc
 58 |      */
 59 |     public function getChartData(): array
 60 |     {
 61 |         return $this->getData(json_decode(self::CHART_DATA));
 62 |     }
 63 | 
 64 |     /**
 65 |      * @inheritDoc
 66 |      */
 67 |     public function setChartData(array $chartData): RedisReportInterface
 68 |     {
 69 |         return $this->setData(self::CHART_DATA, json_encode($chartData));
 70 |     }
 71 | 
 72 |     /**
 73 |      * @inheritDoc
 74 |      */
 75 |     public function getCreatedAt(): string
 76 |     {
 77 |         return $this->getData(self::CREATED_AT);
 78 |     }
 79 | 
 80 |     /**
 81 |      * @inheritDoc
 82 |      */
 83 |     public function setCreatedAt(string $createdAt): RedisReportInterface
 84 |     {
 85 |         return $this->setData(self::CREATED_AT, $createdAt);
 86 |     }
 87 | 
 88 |     /**
 89 |      * @inheritDoc
 90 |      */
 91 |     public function getUpdatedAt(): string
 92 |     {
 93 |         return $this->getData(self::UPDATED_AT);
 94 |     }
 95 | 
 96 |     /**
 97 |      * @inheritDoc
 98 |      */
 99 |     public function setUpdatedAt(string $updatedAt): RedisReportInterface
100 |     {
101 |         return $this->setData(self::UPDATED_AT, $updatedAt);
102 |     }
103 | }
104 | 


--------------------------------------------------------------------------------
/Model/RedisReportRepository.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | namespace Element119\AdminRedisReport\Model;
  9 | 
 10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
 11 | use Element119\AdminRedisReport\Api\Data\RedisReportInterfaceFactory;
 12 | use Element119\AdminRedisReport\Api\Data\RedisReportSearchResultsInterfaceFactory;
 13 | use Element119\AdminRedisReport\Api\RedisReportRepositoryInterface;
 14 | use Element119\AdminRedisReport\Model\ResourceModel\RedisReport as RedisReportResource;
 15 | use Element119\AdminRedisReport\Model\ResourceModel\RedisReport\CollectionFactory as RedisReportCollectionFactory;
 16 | use Exception;
 17 | use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
 18 | use Magento\Framework\Api\SearchCriteriaInterface;
 19 | use Magento\Framework\Api\SearchResults;
 20 | use Magento\Framework\Exception\CouldNotDeleteException;
 21 | use Magento\Framework\Exception\CouldNotSaveException;
 22 | use Magento\Framework\Exception\NoSuchEntityException;
 23 | 
 24 | class RedisReportRepository implements RedisReportRepositoryInterface
 25 | {
 26 |     private RedisReportCollectionFactory $redisReportCollectionFactory;
 27 |     private RedisReportInterfaceFactory $redisReportFactory;
 28 |     private RedisReportResource $resource;
 29 |     private RedisReportSearchResultsInterfaceFactory $searchResultsFactory;
 30 |     private CollectionProcessorInterface $collectionProcessor;
 31 | 
 32 |     public function __construct(
 33 |         RedisReportCollectionFactory $redisReportCollectionFactory,
 34 |         RedisReportInterfaceFactory $redisReportFactory,
 35 |         RedisReportResource $resource,
 36 |         RedisReportSearchResultsInterfaceFactory $searchResultsFactory,
 37 |         CollectionProcessorInterface $collectionProcessor
 38 |     ) {
 39 |         $this->redisReportCollectionFactory = $redisReportCollectionFactory;
 40 |         $this->redisReportFactory = $redisReportFactory;
 41 |         $this->resource = $resource;
 42 |         $this->searchResultsFactory = $searchResultsFactory;
 43 |         $this->collectionProcessor = $collectionProcessor;
 44 |     }
 45 | 
 46 |     /**
 47 |      * @inheritDoc
 48 |      */
 49 |     public function save(RedisReportInterface $redisReport): RedisReportInterface
 50 |     {
 51 |         try {
 52 |             $this->resource->save($redisReport);
 53 |         } catch (Exception $e) {
 54 |             throw new CouldNotSaveException(__('Could not save the report: %1', $e->getMessage()));
 55 |         }
 56 | 
 57 |         return $redisReport;
 58 |     }
 59 | 
 60 |     /**
 61 |      * @inheritDoc
 62 |      */
 63 |     public function getById($redisReportId): RedisReportInterface
 64 |     {
 65 |         $redisReport = $this->redisReportFactory->create();
 66 |         $this->resource->load($redisReport, $redisReportId);
 67 | 
 68 |         if (!$redisReport->getId()) {
 69 |             throw new NoSuchEntityException(__('Redis report with entity ID "%1" does not exist.', $redisReportId));
 70 |         }
 71 | 
 72 |         return $redisReport;
 73 |     }
 74 | 
 75 |     /**
 76 |      * @inheritDoc
 77 |      */
 78 |     public function getList(SearchCriteriaInterface $searchCriteria): SearchResults
 79 |     {
 80 |         $collection = $this->redisReportCollectionFactory->create();
 81 | 
 82 |         $this->collectionProcessor->process($searchCriteria, $collection);
 83 | 
 84 |         $searchResults = $this->searchResultsFactory->create();
 85 |         $searchResults->setSearchCriteria($searchCriteria);
 86 | 
 87 |         $items = [];
 88 | 
 89 |         foreach ($collection as $redisReport) {
 90 |             $items[] = $redisReport;
 91 |         }
 92 | 
 93 |         $searchResults->setItems($items);
 94 |         $searchResults->setTotalCount($collection->getSize());
 95 | 
 96 |         return $searchResults;
 97 |     }
 98 | 
 99 |     /**
100 |      * @inheritDoc
101 |      */
102 |     public function delete(RedisReportInterface $redisReport): bool
103 |     {
104 |         try {
105 |             /** @var RedisReportInterface $redisReportModel */
106 |             $redisReportModel = $this->redisReportFactory->create();
107 | 
108 |             $this->resource->load($redisReportModel, $redisReport->getEntityId());
109 |             $this->resource->delete($redisReportModel);
110 |         } catch (Exception $e) {
111 |             throw new CouldNotDeleteException(__('Could not delete the Redis report with ID: %1', $e->getMessage()));
112 |         }
113 | 
114 |         return true;
115 |     }
116 | 
117 |     /**
118 |      * @inheritDoc
119 |      */
120 |     public function deleteById($redisReportId): bool
121 |     {
122 |         return $this->delete($this->getById($redisReportId));
123 |     }
124 | }
125 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/RedisReport.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Model\ResourceModel;
 9 | 
10 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
11 | use Element119\AdminRedisReport\Api\RedisReportRepositoryInterface;
12 | use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
13 | 
14 | class RedisReport extends AbstractDb
15 | {
16 |     /**
17 |      * @inheritDoc
18 |      */
19 |     protected function _construct()
20 |     {
21 |         $this->_init(RedisReportRepositoryInterface::MAIN_TABLE, RedisReportInterface::ENTITY_ID);
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/RedisReport/Collection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Model\ResourceModel\RedisReport;
 9 | 
10 | use Element119\AdminRedisReport\Model\RedisReport;
11 | use Element119\AdminRedisReport\Model\ResourceModel\RedisReport as RedisReportResourceModel;
12 | use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
13 | 
14 | class Collection extends AbstractCollection
15 | {
16 |     /** @inheritDoc */
17 |     protected $_idFieldName = 'entity_id';
18 | 
19 |     /**
20 |      * @inheritDoc
21 |      */
22 |     protected function _construct()
23 |     {
24 |         $this->_init(RedisReport::class, RedisReportResourceModel::class);
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <div align="center">
  2 | 
  3 | <!-- Module Image Here -->
  4 | 
  5 | </div>
  6 | 
  7 | <h1 align="center">element119 | Admin Redis Report</h1>
  8 | 
  9 | ## 📝 Features
 10 | ✔️ See a snapshot of the health of Redis from the comfort of the Magento admin
 11 | 
 12 | ✔️ Visualise historic Redis health statistics 
 13 | 
 14 | ✔️ Supports Magento Open Source, Adobe Commerce, and Mage-OS
 15 | 
 16 | ✔️ Built in accordance with Magento best practises
 17 | 
 18 | ✔️ Dedicated module configuration section and custom admin user controls
 19 | 
 20 | ✔️ Seamless integration with Magento
 21 | 
 22 | ✔️ Built with developers and extensibility in mind to make customisations as easy as possible
 23 | 
 24 | ✔️ Installable via Composer
 25 | 
 26 | ✔️ Theme agnostic
 27 | 
 28 | ### Upcoming
 29 | ⏳ Ability to filter historic charts by date range
 30 | 
 31 | <br/>
 32 | 
 33 | ## ⛔️ Incompatibilities
 34 | 
 35 | > [!CAUTION]
 36 | > This module is not compatible with Magento instances that utilise the Redis L2 cache and/or the
 37 | > `Magento\Framework\Cache\Backend\RemoteSynchronizedCache` class for the Redis backend cache.
 38 | > 
 39 | > More information is available in the Magento documentation:
 40 | > - [Redis L2 Cache](https://experienceleague.adobe.com/en/docs/commerce-operations/implementation-playbook/best-practices/planning/redis-service-configuration#configure-redis-l2-cache)
 41 | > - [Available Redis Backend Cache Classes](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/configure/env/stage/variables-deploy#redis_backend)
 42 | 
 43 | <br/>
 44 | 
 45 | ## 🔌 Installation
 46 | Run the following command to *install* this module:
 47 | ```bash
 48 | composer require element119/module-admin-redis-report
 49 | php bin/magento setup:upgrade
 50 | ```
 51 | 
 52 | <br/>
 53 | 
 54 | ## ⏫ Updating
 55 | Run the following command to *update* this module:
 56 | ```bash
 57 | composer update element119/module-admin-redis-report
 58 | php bin/magento setup:upgrade
 59 | ```
 60 | 
 61 | <br/>
 62 | 
 63 | ## ❌ Uninstallation
 64 | Run the following command to *uninstall* this module:
 65 | ```bash
 66 | composer remove element119/module-admin-redis-report
 67 | php bin/magento setup:upgrade
 68 | ```
 69 | 
 70 | <br/>
 71 | 
 72 | ## 📚 User Guide
 73 | Configuration for this module can be found in the Magento admin under `Stores -> Settings -> Configuration -> Advanced
 74 | -> System -> Redis Report`.
 75 | 
 76 | <br>
 77 | 
 78 | ### Redis Report
 79 | The Redis information can be found in the admin under `System -> Tools -> Redis Report`.
 80 | 
 81 | <br>
 82 | 
 83 | ### Enable/Disable Historic Data
 84 | The periodic capture of Redis information can be disabled by setting this option to `No`. This is set to `Yes` by
 85 | default.
 86 | 
 87 | <br>
 88 | 
 89 | ### Historic Data Retention Period
 90 | The value specified here determines how long Magento will store historic Redis report data, measured in days.
 91 | An empty value means data will be kept indefinitely.
 92 | 
 93 | ## 📸 Screenshots & GIFs
 94 | ### Admin Configuration
 95 | ![admin-config](https://github.com/element119/module-admin-redis-report/assets/40261741/853aea10-d995-4cb1-a4d7-9dc7cdccafd3)
 96 | 
 97 | <br>
 98 | 
 99 | ### Admin Report
100 | ![admin-report](https://github.com/element119/module-admin-redis-report/assets/40261741/5015905d-fb0d-40fe-99f5-b5ec29b207ee)
101 | 


--------------------------------------------------------------------------------
/Scope/Config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\AdminRedisReport\Scope;
 9 | 
10 | use Magento\Framework\App\Config\ScopeConfigInterface;
11 | 
12 | class Config
13 | {
14 |     private const XML_PATH_LOG_CRON_ENABLED = 'system/redis_report/cron_enable';
15 |     private const XML_PATH_LOG_TRUNCATE_DAYS = 'system/redis_report/log_truncate_days';
16 | 
17 |     private ScopeConfigInterface $scopeConfig;
18 | 
19 |     public function __construct(
20 |         ScopeConfigInterface $scopeConfig
21 |     ) {
22 |         $this->scopeConfig = $scopeConfig;
23 |     }
24 | 
25 |     public function isRedisReportLoggingCronEnabled(): bool
26 |     {
27 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_LOG_CRON_ENABLED);
28 |     }
29 | 
30 |     public function getRedisReportLogTruncateDays(): int
31 |     {
32 |         return (int)$this->scopeConfig->getValue(self::XML_PATH_LOG_TRUNCATE_DAYS);
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "element119/module-admin-redis-report",
 3 |     "type": "magento2-module",
 4 |     "description": "A Magento 2 module that displays Redis information in the admin.",
 5 |     "license": "MIT",
 6 |     "authors": [
 7 |         {
 8 |             "name": "element119",
 9 |             "email": "hello@element119.co.uk"
10 |         }
11 |     ],
12 |     "require": {
13 |         "php": "^7.4 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
14 |         "magento/module-backend": "*",
15 |         "ext-json": "*"
16 |     },
17 |     "suggest": {
18 |         "ethanyehuda/magento2-cronjobmanager": "A module for managing scheduled cron jobs from magento's admin panel"
19 |     },
20 |     "autoload": {
21 |         "psr-4": {
22 |             "Element119\\AdminRedisReport\\": ""
23 |         },
24 |         "files": [
25 |             "registration.php"
26 |         ]
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/etc/acl.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
10 |     <acl>
11 |         <resources>
12 |             <resource id="Magento_Backend::admin">
13 |                 <resource id="Magento_Backend::system">
14 |                     <resource id="Magento_Backend::tools">
15 |                         <resource id="Element119_AdminRedisReport::view"
16 |                                   title="Redis Report View"
17 |                                   translate="title"
18 |                                   sortOrder="1000"/>
19 |                     </resource>
20 |                 </resource>
21 |             </resource>
22 |         </resources>
23 |     </acl>
24 | </config>
25 | 


--------------------------------------------------------------------------------
/etc/adminhtml/menu.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Backend:etc/menu.xsd">
10 |     <menu>
11 |         <add id="Element119_AdminRedisReport::view"
12 |              title="Redis Report"
13 |              action="redis_report/index"
14 |              translate="title"
15 |              module="Element119_AdminRedisReport"
16 |              sortOrder="1000"
17 |              parent="Magento_Backend::system_tools"
18 |              resource="Element119_AdminRedisReport::view"/>
19 |     </menu>
20 | </config>
21 | 


--------------------------------------------------------------------------------
/etc/adminhtml/routes.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
10 |     <router id="admin">
11 |         <route id="redis_report" frontName="redis_report">
12 |             <module name="Element119_AdminRedisReport"/>
13 |         </route>
14 |     </router>
15 | </config>
16 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
10 |     <system>
11 |         <section id="system">
12 |             <group id="redis_report"
13 |                    translate="label"
14 |                    type="text"
15 |                    sortOrder="1100"
16 |                    showInDefault="1"
17 |                    showInWebsite="0"
18 |                    showInStore="0">
19 |                 <label>Redis Report</label>
20 |                 <field id="cron_enable"
21 |                        translate="label comment"
22 |                        type="select"
23 |                        sortOrder="10"
24 |                        showInDefault="1"
25 |                        showInWebsite="0"
26 |                        showInStore="0"
27 |                        canRestore="1">
28 |                     <label>Collect Redis Report Data Periodically</label>
29 |                     <comment>The default schedule is every 30 minutes but this may have been changed.</comment>
30 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
31 |                 </field>
32 |                 <field id="log_truncate_days"
33 |                        translate="label comment"
34 |                        type="text"
35 |                        sortOrder="20"
36 |                        showInDefault="1"
37 |                        showInWebsite="0"
38 |                        showInStore="0"
39 |                        canRestore="1">
40 |                     <label>Number of Days to Keep Historic Redis Report Data</label>
41 |                     <comment>Absence of a value means historic report data will not be deleted.</comment>
42 |                     <validate>integer validate-digits validate-not-negative-number</validate>
43 |                     <depends>
44 |                         <field id="system/redis_report/cron_enable">1</field>
45 |                     </depends>
46 |                 </field>
47 |             </group>
48 |         </section>
49 |     </system>
50 | </config>
51 | 


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
10 |     <default>
11 |         <system>
12 |             <redis_report>
13 |                 <cron_enable>1</cron_enable>
14 |                 <log_truncate_days>28</log_truncate_days>
15 |             </redis_report>
16 |         </system>
17 |     </default>
18 | </config>
19 | 


--------------------------------------------------------------------------------
/etc/crontab.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
10 |     <group id="default">
11 |         <job name="redis_report_logger"
12 |              instance="Element119\AdminRedisReport\Cron\Log"
13 |              method="execute">
14 |             <schedule>0 * * * *</schedule>
15 |         </job>
16 |         <job name="redis_report_log_clean"
17 |              instance="Element119\AdminRedisReport\Cron\Clean"
18 |              method="execute">
19 |             <schedule>0 1 * * *</schedule>
20 |         </job>
21 |     </group>
22 | </config>
23 | 


--------------------------------------------------------------------------------
/etc/db_schema.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema.xsd">
10 |     <table name="e119_redis_report" resource="default" engine="innodb" comment="Historic Redis Report Entries">
11 |         <column name="entity_id"
12 |                 xsi:type="int"
13 |                 unsigned="true"
14 |                 nullable="false"
15 |                 identity="true"
16 |                 comment="Entity ID"/>
17 |         <column name="report_data"
18 |                 xsi:type="json"
19 |                 nullable="true"
20 |                 comment="Report Data as JSON"/>
21 |         <column name="chart_data"
22 |                 xsi:type="json"
23 |                 nullable="true"
24 |                 comment="Chart Specific Data as JSON"/>
25 |         <column name="created_at"
26 |                 xsi:type="timestamp"
27 |                 on_update="false"
28 |                 nullable="false"
29 |                 default="CURRENT_TIMESTAMP"
30 |                 comment="Report Creation Time"/>
31 |         <column name="updated_at"
32 |                 xsi:type="timestamp"
33 |                 on_update="true"
34 |                 nullable="false"
35 |                 default="CURRENT_TIMESTAMP"
36 |                 comment="Report Update Time"/>
37 |         <constraint xsi:type="primary" referenceId="PRIMARY">
38 |             <column name="entity_id"/>
39 |         </constraint>
40 |     </table>
41 | </schema>
42 | 


--------------------------------------------------------------------------------
/etc/di.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
10 |     <!-- Concrete Interface Implementations -->
11 |     <preference for="Element119\AdminRedisReport\Api\Data\RedisReportInterface"
12 |                 type="Element119\AdminRedisReport\Model\RedisReport"/>
13 |     <preference for="Element119\AdminRedisReport\Api\Data\RedisReportSearchResultsInterface"
14 |                 type="Magento\Framework\Api\SearchResults"/>
15 |     <preference for="Element119\AdminRedisReport\Api\RedisReportRepositoryInterface"
16 |                 type="Element119\AdminRedisReport\Model\RedisReportRepository"/>
17 | </config>
18 | 


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
10 |     <module name="Element119_AdminRedisReport">
11 |         <sequence>
12 |             <module name="Magento_Backend"/>
13 |         </sequence>
14 |     </module>
15 | </config>
16 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | use Magento\Framework\Component\ComponentRegistrar;
 9 | 
10 | ComponentRegistrar::register(
11 |     ComponentRegistrar::MODULE,
12 |     'Element119_AdminRedisReport',
13 |     __DIR__
14 | );
15 | 


--------------------------------------------------------------------------------
/view/adminhtml/layout/redis_report_index_index.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |       xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
10 |     <head>
11 |         <css src="Element119_AdminRedisReport::css/module.css"/>
12 |     </head>
13 |     <body>
14 |         <referenceContainer name="content">
15 |             <block name="redis.info.wrapper" template="Element119_AdminRedisReport::wrapper.phtml">
16 |                 <arguments>
17 |                     <argument name="redis_info_view_model" xsi:type="object">Element119\AdminRedisReport\Model\RedisInfo</argument>
18 |                 </arguments>
19 | 
20 |                 <block name="redis.info.databases" template="Element119_AdminRedisReport::info/databases.phtml"/>
21 |                 <block name="redis.info.memory" template="Element119_AdminRedisReport::info/memory.phtml"/>
22 |                 <block name="redis.info.activity" template="Element119_AdminRedisReport::info/activity.phtml"/>
23 |                 <block name="redis.info.connections" template="Element119_AdminRedisReport::info/connections.phtml"/>
24 |             </block>
25 |         </referenceContainer>
26 |     </body>
27 | </page>
28 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/info/activity.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
  9 | use Element119\AdminRedisReport\Model\RedisInfo;
 10 | use Magento\Backend\Block\Template;
 11 | use Magento\Framework\Escaper;
 12 | 
 13 | /** @var Escaper $escaper */
 14 | /** @var Template $block */
 15 | /** @var array $redisInfo */
 16 | /** @see RedisInfo::get() */
 17 | $redisInfo = $block->getData('redis_info');
 18 | $historicData = $block->getData('historic_redis_data');
 19 | $historicChartData = array_column($historicData, RedisReportInterface::CHART_DATA);
 20 | ?>
 21 | <section id="activity">
 22 |     <h2><?= $escaper->escapeHtml(__('Activity')); ?></h2>
 23 | 
 24 |     <div class="activity-wrapper">
 25 |         <div class="activity-data">
 26 |             <h3><?= $escaper->escapeHtml(__('Live Data Snapshot')); ?></h3>
 27 |             <ul class="data-list">
 28 |                 <?php foreach ($redisInfo['activity'] as $key => $value): ?>
 29 |                     <li>
 30 |                         <b><?= $escaper->escapeHtml(__($key)); ?>:</b>
 31 |                         <?= $escaper->escapeHtml($value); ?>
 32 |                     </li>
 33 |                 <?php endforeach; ?>
 34 |             </ul>
 35 |         </div>
 36 | 
 37 |         <?php if ($historicChartData && $historicActivityChartData = array_column($historicChartData, 'activity')): ?>
 38 |             <div class="activity-charts">
 39 |                 <h3><?= $escaper->escapeHtml(__('History')); ?></h3>
 40 |                 <div class="activity-chart">
 41 |                     <canvas id="raw-keyspace-activity-chart"
 42 |                             width="1250"
 43 |                             height="500"/>
 44 |                     <script type="text/x-magento-init">
 45 |                         {
 46 |                             "#raw-keyspace-activity-chart": {
 47 |                                 "Element119_AdminRedisReport/js/chart": {
 48 |                                     "type": "line",
 49 |                                     "data": {
 50 |                                         "labels": <?= /** @noEscape */ json_encode(
 51 |                                             array_column($historicChartData, RedisReportInterface::CREATED_AT)
 52 |                                         ); ?>,
 53 |                                         "datasets": [
 54 |                                             {
 55 |                                                 "label": "<?= $escaper->escapeJs(__('Keyspace Hits')); ?>",
 56 |                                                 "data": <?= /** @noEscape */ json_encode(
 57 |                                                     array_map(
 58 |                                                         'intval',
 59 |                                                         array_column($historicActivityChartData, 'Keyspace Hits')
 60 |                                                     )
 61 |                                                 ); ?>
 62 |                                             },
 63 |                                             {
 64 |                                                 "label": "<?= $escaper->escapeJs(__('Keyspace Misses')); ?>",
 65 |                                                 "data": <?= /** @noEscape */ json_encode(
 66 |                                                     array_map(
 67 |                                                         'intval',
 68 |                                                         array_column($historicActivityChartData, 'Keyspace Misses')
 69 |                                                     )
 70 |                                                 ); ?>
 71 |                                             },
 72 |                                             {
 73 |                                                 "label": "<?= $escaper->escapeJs(__('Total Error Replies')); ?>",
 74 |                                                 "data": <?= /** @noEscape */ json_encode(
 75 |                                                     array_map(
 76 |                                                         'intval',
 77 |                                                         array_column($historicActivityChartData, 'Total Error Replies')
 78 |                                                     )
 79 |                                                 ); ?>
 80 |                                             },
 81 |                                             {
 82 |                                                 "label": "<?= $escaper->escapeJs(__('Evicted Keys')); ?>",
 83 |                                                 "data": <?= /** @noEscape */ json_encode(
 84 |                                                     array_map(
 85 |                                                         'intval',
 86 |                                                         array_column($historicActivityChartData, 'Evicted Keys')
 87 |                                                     )
 88 |                                                 ); ?>
 89 |                                             },
 90 |                                             {
 91 |                                                 "label": "<?= $escaper->escapeJs(__('Expired Keys')); ?>",
 92 |                                                 "data": <?= /** @noEscape */ json_encode(
 93 |                                                     array_map(
 94 |                                                         'intval',
 95 |                                                         array_column($historicActivityChartData, 'Expired Keys')
 96 |                                                     )
 97 |                                                 ); ?>
 98 |                                             }
 99 |                                         ]
100 |                                     },
101 |                                     "options": {
102 |                                         "responsive": true,
103 |                                         "interaction": {
104 |                                             "mode": "index",
105 |                                             "intersect": false
106 |                                         },
107 |                                         "stacked": false,
108 |                                         "plugins": {
109 |                                             "legend": {
110 |                                                 "position": "top"
111 |                                             }
112 |                                         },
113 |                                         "scales": {
114 |                                             "y": {
115 |                                                 "beginAtZero": false
116 |                                             }
117 |                                         }
118 |                                     }
119 |                                 }
120 |                             }
121 |                         }
122 |                     </script>
123 |                 </div>
124 |                 <div class="activity-chart">
125 |                     <canvas id="keyspace-hit-rate-chart"
126 |                             width="1250"
127 |                             height="500"/>
128 |                     <script type="text/x-magento-init">
129 |                         {
130 |                             "#keyspace-hit-rate-chart": {
131 |                                 "Element119_AdminRedisReport/js/chart": {
132 |                                     "type": "line",
133 |                                     "data": {
134 |                                         "labels": <?= /** @noEscape */ json_encode(
135 |                                             array_column($historicChartData, RedisReportInterface::CREATED_AT)
136 |                                         ); ?>,
137 |                                         "datasets": [
138 |                                             {
139 |                                                 "label": "<?= $escaper->escapeJs(__('Hit Rate')); ?>",
140 |                                                 "data": <?= /** @noEscape */ json_encode(
141 |                                                     array_map(
142 |                                                         'floatval',
143 |                                                         array_column($historicActivityChartData, 'Hit Rate')
144 |                                                     )
145 |                                                 ); ?>
146 |                                             }
147 |                                         ]
148 |                                     },
149 |                                     "options": {
150 |                                         "responsive": true,
151 |                                         "interaction": {
152 |                                             "mode": "index",
153 |                                             "intersect": false
154 |                                         },
155 |                                         "stacked": false,
156 |                                         "plugins": {
157 |                                             "legend": {
158 |                                                 "position": "top"
159 |                                             }
160 |                                         },
161 |                                         "scales": {
162 |                                             "y": {
163 |                                                 "min": 0,
164 |                                                 "max": 100
165 |                                             }
166 |                                         }
167 |                                     }
168 |                                 }
169 |                             }
170 |                         }
171 |                     </script>
172 |                 </div>
173 |                 <div class="activity-chart">
174 |                     <canvas id="cpu-time-activity-chart"
175 |                             width="1250"
176 |                             height="500"/>
177 |                     <script type="text/x-magento-init">
178 |                         {
179 |                             "#cpu-time-activity-chart": {
180 |                                 "Element119_AdminRedisReport/js/chart": {
181 |                                     "type": "line",
182 |                                     "data": {
183 |                                         "labels": <?= /** @noEscape */ json_encode(
184 |                                             array_column($historicChartData, RedisReportInterface::CREATED_AT)
185 |                                         ); ?>,
186 |                                         "datasets": [
187 |                                             {
188 |                                                 "label": "<?= $escaper->escapeJs(__('Sys CPU Time (Secs)')); ?>",
189 |                                                 "data": <?= /** @noEscape */ json_encode(
190 |                                                     array_map(
191 |                                                         'floatval',
192 |                                                         array_column($historicActivityChartData, 'Used CPU Time (Sys)')
193 |                                                     )
194 |                                                 ); ?>
195 |                                             },
196 |                                             {
197 |                                                 "label": "<?= $escaper->escapeJs(__('User CPU Time (Secs)')); ?>",
198 |                                                 "data": <?= /** @noEscape */ json_encode(
199 |                                                     array_map(
200 |                                                         'floatval',
201 |                                                         array_column($historicActivityChartData, 'Used CPU Time (User)')
202 |                                                     )
203 |                                                 ); ?>
204 |                                             }
205 |                                         ]
206 |                                     },
207 |                                     "options": {
208 |                                         "responsive": true,
209 |                                         "interaction": {
210 |                                             "mode": "index",
211 |                                             "intersect": false
212 |                                         },
213 |                                         "stacked": false,
214 |                                         "plugins": {
215 |                                             "legend": {
216 |                                                 "position": "top"
217 |                                             }
218 |                                         },
219 |                                         "scales": {
220 |                                             "y": {
221 |                                                 "beginAtZero": false
222 |                                             }
223 |                                         }
224 |                                     }
225 |                                 }
226 |                             }
227 |                         }
228 |                     </script>
229 |                 </div>
230 |                 <div class="activity-chart">
231 |                     <canvas id="io-activity-chart"
232 |                             width="1250"
233 |                             height="500"/>
234 |                     <script type="text/x-magento-init">
235 |                         {
236 |                             "#io-activity-chart": {
237 |                                 "Element119_AdminRedisReport/js/chart": {
238 |                                     "type": "line",
239 |                                     "data": {
240 |                                         "labels": <?= /** @noEscape */ json_encode(
241 |                                             array_column($historicChartData, RedisReportInterface::CREATED_AT)
242 |                                         ); ?>,
243 |                                         "datasets": [
244 |                                             {
245 |                                                 "label": "<?= $escaper->escapeJs(__('Total Reads Processed')); ?>",
246 |                                                 "data": <?= /** @noEscape */ json_encode(
247 |                                                     array_map(
248 |                                                         'floatval',
249 |                                                         array_column($historicActivityChartData, 'Total Reads Processed')
250 |                                                     )
251 |                                                 ); ?>
252 |                                             },
253 |                                             {
254 |                                                 "label": "<?= $escaper->escapeJs(__('Total Writes Processed')); ?>",
255 |                                                 "data": <?= /** @noEscape */ json_encode(
256 |                                                     array_map(
257 |                                                         'floatval',
258 |                                                         array_column($historicActivityChartData, 'Total Writes Processed')
259 |                                                     )
260 |                                                 ); ?>
261 |                                             }
262 |                                         ]
263 |                                     },
264 |                                     "options": {
265 |                                         "responsive": true,
266 |                                         "interaction": {
267 |                                             "mode": "index",
268 |                                             "intersect": false
269 |                                         },
270 |                                         "stacked": false,
271 |                                         "plugins": {
272 |                                             "legend": {
273 |                                                 "position": "top"
274 |                                             }
275 |                                         },
276 |                                         "scales": {
277 |                                             "y": {
278 |                                                 "beginAtZero": false
279 |                                             }
280 |                                         }
281 |                                     }
282 |                                 }
283 |                             }
284 |                         }
285 |                     </script>
286 |                 </div>
287 |             </div>
288 |         <?php endif; ?>
289 |     </div>
290 | </section>
291 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/info/connections.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | use Element119\AdminRedisReport\Model\RedisInfo;
  9 | use Magento\Backend\Block\Template;
 10 | use Magento\Framework\Escaper;
 11 | 
 12 | /** @var Escaper $escaper */
 13 | /** @var Template $block */
 14 | /** @var array $redisInfo */
 15 | /** @see RedisInfo::get() */
 16 | $redisInfo = $block->getData('redis_info');
 17 | $historicData = $block->getData('historic_redis_data');
 18 | $connectionsHistory = array_column($historicData, 'connections');
 19 | ?>
 20 | <section id="connections">
 21 |     <h2><?= $escaper->escapeHtml(__('Connections')); ?></h2>
 22 | 
 23 |     <div class="connections-wrapper">
 24 |         <div class="connections-data">
 25 |             <h3><?= $escaper->escapeHtml(__('Live Data Snapshot')); ?></h3>
 26 |             <ul class="data-list">
 27 |                 <?php foreach ($redisInfo['connections'] as $key => $value): ?>
 28 |                     <li>
 29 |                         <b><?= $escaper->escapeHtml(__($key)); ?>:</b>
 30 |                         <?= $escaper->escapeHtml($value); ?>
 31 |                     </li>
 32 |                 <?php endforeach; ?>
 33 |             </ul>
 34 |         </div>
 35 | 
 36 |         <?php if ($connectionsHistory): ?>
 37 |             <div class="connections-charts">
 38 |                 <h3><?= $escaper->escapeHtml(__('History')); ?></h3>
 39 |                 <div class="connections-chart">
 40 |                     <canvas id="connections-chart"
 41 |                             width="1250"
 42 |                             height="500"/>
 43 |                     <script type="text/x-magento-init">
 44 |                         {
 45 |                             "#connections-chart": {
 46 |                                 "Element119_AdminRedisReport/js/chart": {
 47 |                                     "type": "line",
 48 |                                     "data": {
 49 |                                         "labels": <?= /** @noEscape */ json_encode(array_keys($historicData)); ?>,
 50 |                                         "datasets": [
 51 |                                             {
 52 |                                                 "label": "<?= $escaper->escapeJs(__('Max. Clients')); ?>",
 53 |                                                 "data": <?= /** @noEscape */ json_encode(
 54 |                                                     array_column($connectionsHistory, 'Max. Clients')
 55 |                                                 ); ?>
 56 |                                             },
 57 |                                             {
 58 |                                                 "label": "<?= $escaper->escapeJs(__('Connected Clients')); ?>",
 59 |                                                 "data": <?= /** @noEscape */ json_encode(
 60 |                                                     array_column($connectionsHistory, 'Connected Clients')
 61 |                                                 ); ?>
 62 |                                             },
 63 |                                             {
 64 |                                                 "label": "<?= $escaper->escapeJs(__('Cluster Connections')); ?>",
 65 |                                                 "data": <?= /** @noEscape */ json_encode(
 66 |                                                     array_column($connectionsHistory, 'Cluster Connections')
 67 |                                                 ); ?>
 68 |                                             },
 69 |                                             {
 70 |                                                 "label": "<?= $escaper->escapeJs(__('Rejected Connections')); ?>",
 71 |                                                 "data": <?= /** @noEscape */ json_encode(
 72 |                                                     array_column($connectionsHistory, 'Rejected Connections')
 73 |                                                 ); ?>
 74 |                                             }
 75 |                                         ]
 76 |                                     },
 77 |                                     "options": {
 78 |                                         "responsive": true,
 79 |                                         "interaction": {
 80 |                                             "mode": "index",
 81 |                                             "intersect": false
 82 |                                         },
 83 |                                         "stacked": false,
 84 |                                         "plugins": {
 85 |                                             "legend": {
 86 |                                                 "position": "top"
 87 |                                             }
 88 |                                         },
 89 |                                         "scales": {
 90 |                                             "y": {
 91 |                                                 "beginAtZero": true
 92 |                                             }
 93 |                                         }
 94 |                                     }
 95 |                                 }
 96 |                             }
 97 |                         }
 98 |                     </script>
 99 |                 </div>
100 |             </div>
101 |         <?php endif; ?>
102 |     </div>
103 | </section>
104 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/info/databases.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | use Element119\AdminRedisReport\Model\RedisInfo;
  9 | use Magento\Backend\Block\Template;
 10 | use Magento\Framework\Escaper;
 11 | 
 12 | /** @var Escaper $escaper */
 13 | /** @var Template $block */
 14 | /** @var array $redisInfo */
 15 | /** @see RedisInfo::get() */
 16 | $redisInfo = $block->getData('redis_info');
 17 | $historicData = $block->getData('historic_redis_data');
 18 | $databasesHistory = array_column($historicData, 'databases');
 19 | ?>
 20 | <section id="databases">
 21 |     <h2><?= $escaper->escapeHtml(__('Database(s)')); ?></h2>
 22 | 
 23 |     <div class="database-wrapper">
 24 |         <?php foreach ($redisInfo['databases'] as $dbNumber => $data): ?>
 25 |             <div class="database-info">
 26 |                 <div class="database-data">
 27 |                     <h3><?= $escaper->escapeHtml(__('Live Data Snapshot')); ?></h3>
 28 |                     <b><?= $escaper->escapeHtml($dbNumber); ?></b>
 29 |                     <ul class="data-list">
 30 |                         <?php foreach ($data as $key => $value): ?>
 31 |                             <li>
 32 |                                 <b><?= $escaper->escapeHtml(ucwords(str_replace('_', ' ', $key))); ?>:</b>
 33 |                                 <?= $escaper->escapeHtml($value); ?>
 34 |                             </li>
 35 |                         <?php endforeach; ?>
 36 |                     </ul>
 37 |                 </div>
 38 | 
 39 |                 <?php if ($databasesHistory
 40 |                     && $historicDbNumberData = array_column($databasesHistory, $dbNumber)
 41 |                 ): ?>
 42 |                     <div class="database-charts">
 43 |                         <div class="database-chart">
 44 |                             <h3><?= $escaper->escapeHtml(__('History')); ?></h3>
 45 |                             <canvas id="<?= $escaper->escapeHtmlAttr(
 46 |                                         sprintf('database-%s-keyspace-chart', $dbNumber)
 47 |                                     ); ?>"
 48 |                                     width="1250"
 49 |                                     height="500"/>
 50 |                             <script type="text/x-magento-init">
 51 |                                 {
 52 |                                     "#<?= $escaper->escapeHtml(sprintf('database-%s-keyspace-chart', $dbNumber)); ?>": {
 53 |                                         "Element119_AdminRedisReport/js/chart": {
 54 |                                             "type": "line",
 55 |                                             "data": {
 56 |                                                 "labels": <?= /** @noEscape */ json_encode(array_keys($historicData)); ?>,
 57 |                                                 "datasets": [
 58 |                                                     {
 59 |                                                         "label": "<?= $escaper->escapeHtml(__('Keys')); ?>",
 60 |                                                         "data": <?= /** @noEscape */ json_encode(array_column($historicDbNumberData, 'keys')); ?>
 61 |                                                     },
 62 |                                                     {
 63 |                                                         "label": "<?= $escaper->escapeHtml(__('Expiring Keys')); ?>",
 64 |                                                         "data": <?= /** @noEscape */ json_encode(array_column($historicDbNumberData, 'expires')); ?>
 65 |                                                     }
 66 |                                                 ]
 67 |                                             },
 68 |                                             "options": {
 69 |                                                 "responsive": true,
 70 |                                                 "interaction": {
 71 |                                                     "mode": "index",
 72 |                                                     "intersect": false
 73 |                                                 },
 74 |                                                 "stacked": false,
 75 |                                                 "plugins": {
 76 |                                                     "legend": {
 77 |                                                         "position": "top"
 78 |                                                     }
 79 |                                                 },
 80 |                                                 "scales": {
 81 |                                                     "y": {
 82 |                                                         "beginAtZero": true
 83 |                                                     }
 84 |                                                 }
 85 |                                             }
 86 |                                         }
 87 |                                     }
 88 |                                 }
 89 |                             </script>
 90 |                         </div>
 91 |                         <div class="database-chart">
 92 |                             <canvas id="<?= $escaper->escapeHtmlAttr(sprintf('database-%s-ttl-chart', $dbNumber)); ?>"
 93 |                                     width="1250"
 94 |                                     height="500"/>
 95 |                             <script type="text/x-magento-init">
 96 |                                 {
 97 |                                     "#<?= $escaper->escapeHtml(sprintf('database-%s-ttl-chart', $dbNumber)); ?>": {
 98 |                                         "Element119_AdminRedisReport/js/chart": {
 99 |                                             "type": "line",
100 |                                             "data": {
101 |                                                 "labels": <?= /** @noEscape */ json_encode(array_keys($historicData)); ?>,
102 |                                                 "datasets": [
103 |                                                     {
104 |                                                         "label": "<?= $escaper->escapeHtml(__('Average Key TTL (mins)')); ?>",
105 |                                                         "data": <?= /** @noEscape */ json_encode(
106 |                                                             array_map(
107 |                                                                 function ($ttl) {
108 |                                                                     $ttlValue = str_replace(' seconds', '', (string)$ttl);
109 | 
110 |                                                                     return((float)$ttlValue) / 1000 / 60; // convert to minutes
111 |                                                                 },
112 |                                                                 array_column($historicDbNumberData, 'avg_ttl')
113 |                                                             )
114 |                                                         ); ?>
115 |                                                     }
116 |                                                 ]
117 |                                             },
118 |                                             "options": {
119 |                                                 "responsive": true,
120 |                                                 "interaction": {
121 |                                                     "mode": "index",
122 |                                                     "intersect": false
123 |                                                 },
124 |                                                 "stacked": false,
125 |                                                 "plugins": {
126 |                                                     "legend": {
127 |                                                         "position": "top"
128 |                                                     }
129 |                                                 },
130 |                                                 "scales": {
131 |                                                     "y": {
132 |                                                         "beginAtZero": true
133 |                                                     }
134 |                                                 }
135 |                                             }
136 |                                         }
137 |                                     }
138 |                                 }
139 |                             </script>
140 |                         </div>
141 |                     </div>
142 |                 <?php endif; ?>
143 |             </div>
144 |         <?php endforeach; ?>
145 |     </div>
146 | </section>
147 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/info/memory.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | use Element119\AdminRedisReport\Api\Data\RedisReportInterface;
  9 | use Element119\AdminRedisReport\Model\RedisInfo;
 10 | use Magento\Backend\Block\Template;
 11 | use Magento\Framework\Escaper;
 12 | 
 13 | /** @var Escaper $escaper */
 14 | /** @var Template $block */
 15 | /** @var array $redisInfo */
 16 | /** @see RedisInfo::get() */
 17 | $redisInfo = $block->getData('redis_info');
 18 | $historicData = $block->getData('historic_redis_data');
 19 | $historicChartData = array_column($historicData, RedisReportInterface::CHART_DATA);
 20 | ?>
 21 | <section id="memory">
 22 |     <h2><?= $escaper->escapeHtml(__('Memory')); ?></h2>
 23 | 
 24 |     <div class="memory-wrapper">
 25 |         <div class="memory-data">
 26 |             <h3><?= $escaper->escapeHtml(__('Live Data Snapshot')); ?></h3>
 27 |             <ul class="data-list">
 28 |                 <?php foreach ($redisInfo['memory'] as $key => $value): ?>
 29 |                     <li>
 30 |                         <b><?= $escaper->escapeHtml(__($key)); ?>:</b>
 31 |                         <?= $escaper->escapeHtml($value); ?>
 32 |                     </li>
 33 |                 <?php endforeach; ?>
 34 |             </ul>
 35 |         </div>
 36 | 
 37 |         <?php if ($historicChartData && $historicMemoryChartData = array_column($historicChartData, 'memory')): ?>
 38 |             <div class="memory-charts">
 39 |                 <h3><?= $escaper->escapeHtml(__('History')); ?></h3>
 40 |                 <div class="memory-chart">
 41 |                     <canvas id="raw-memory-usage-chart"
 42 |                             width="1250"
 43 |                             height="500"/>
 44 |                     <script type="text/x-magento-init">
 45 |                         {
 46 |                             "#raw-memory-usage-chart": {
 47 |                                 "Element119_AdminRedisReport/js/chart": {
 48 |                                     "type": "line",
 49 |                                     "data": {
 50 |                                         "labels": <?= /** @noEscape */ json_encode(
 51 |                                             array_column($historicChartData, RedisReportInterface::CREATED_AT)
 52 |                                         ); ?>,
 53 |                                         "datasets": [
 54 |                                             {
 55 |                                                 "label": "<?= $escaper->escapeJs(__('Used Memory (MB)')); ?>",
 56 |                                                 "data": <?= /** @noEscape */ json_encode(
 57 |                                                     array_map(
 58 |                                                         function ($memoryChartData) {
 59 |                                                             return $memoryChartData['Used Memory'] / pow(1024, 2);
 60 |                                                         },
 61 |                                                         $historicMemoryChartData
 62 |                                                     )
 63 |                                                 ); ?>
 64 |                                             },
 65 |                                             {
 66 |                                                 "label": "<?= $escaper->escapeJs(__('Used Memory Peak (MB)')); ?>",
 67 |                                                 "data": <?= /** @noEscape */ json_encode(
 68 |                                                     array_map(
 69 |                                                         function ($memoryChartData) {
 70 |                                                             return $memoryChartData['Used Memory Peak'] / pow(1024, 2);
 71 |                                                         },
 72 |                                                         $historicMemoryChartData
 73 |                                                     )
 74 |                                                 ); ?>
 75 |                                             }
 76 |                                         ]
 77 |                                     },
 78 |                                     "options": {
 79 |                                         "responsive": true,
 80 |                                         "interaction": {
 81 |                                             "mode": "index",
 82 |                                             "intersect": false
 83 |                                         },
 84 |                                         "stacked": false,
 85 |                                         "plugins": {
 86 |                                             "legend": {
 87 |                                                 "position": "top"
 88 |                                             }
 89 |                                         },
 90 |                                         "scales": {
 91 |                                             "y": {
 92 |                                                 "beginAtZero": true
 93 |                                             }
 94 |                                         }
 95 |                                     }
 96 |                                 }
 97 |                             }
 98 |                         }
 99 |                     </script>
100 |                 </div>
101 |                 <div class="memory-chart">
102 |                     <canvas id="percentage-memory-usage-chart"
103 |                             width="1250"
104 |                             height="500"/>
105 |                     <script type="text/x-magento-init">
106 |                         {
107 |                             "#percentage-memory-usage-chart": {
108 |                                 "Element119_AdminRedisReport/js/chart": {
109 |                                     "type": "line",
110 |                                     "data": {
111 |                                         "labels": <?= /** @noEscape */ json_encode(
112 |                                             array_column($historicChartData, RedisReportInterface::CREATED_AT)
113 |                                         ); ?>,
114 |                                         "datasets": [
115 |                                             {
116 |                                                 "label": "<?= $escaper->escapeJs(
117 |                                                     __('Used Memory Peak Percentage')
118 |                                                 ); ?>",
119 |                                                 "data": <?= /** @noEscape */ json_encode(
120 |                                                     array_map(
121 |                                                         'floatval',
122 |                                                         array_column(
123 |                                                             $historicMemoryChartData,
124 |                                                             'Used Memory Peak Percentage'
125 |                                                         )
126 |                                                     )
127 |                                                 ); ?>
128 |                                             },
129 |                                             {
130 |                                                 "label": "<?= $escaper->escapeJs(
131 |                                                     __('Used Memory Dataset Percentage')
132 |                                                 ); ?>",
133 |                                                 "data": <?= /** @noEscape */ json_encode(
134 |                                                     array_map(
135 |                                                         'floatval',
136 |                                                         array_column(
137 |                                                             $historicMemoryChartData,
138 |                                                             'Used Memory Dataset Percentage'
139 |                                                         )
140 |                                                     )
141 |                                                 ); ?>
142 |                                             },
143 |                                             {
144 |                                                 "label": "<?= $escaper->escapeJs(
145 |                                                     __('Percentage of Keys Used by Magento')
146 |                                                 ); ?>",
147 |                                                 "data": <?= /** @noEscape */ json_encode(
148 |                                                     array_map(
149 |                                                         'floatval',
150 |                                                         array_column(
151 |                                                             $historicMemoryChartData,
152 |                                                             'Percentage of Keys Used by Magento'
153 |                                                         )
154 |                                                     )
155 |                                                 ); ?>
156 |                                             }
157 |                                         ]
158 |                                     },
159 |                                     "options": {
160 |                                         "responsive": true,
161 |                                         "interaction": {
162 |                                             "mode": "index",
163 |                                             "intersect": false
164 |                                         },
165 |                                         "stacked": false,
166 |                                         "plugins": {
167 |                                             "legend": {
168 |                                                 "position": "top"
169 |                                             }
170 |                                         },
171 |                                         "scales": {
172 |                                             "y": {
173 |                                                 "beginAtZero": true
174 |                                             }
175 |                                         }
176 |                                     }
177 |                                 }
178 |                             }
179 |                         }
180 |                     </script>
181 |                 </div>
182 |             </div>
183 |         <?php endif; ?>
184 |     </div>
185 | </section>
186 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/wrapper.phtml:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | use Element119\AdminRedisReport\Model\RedisInfo;
 9 | use Magento\Backend\Block\Template;
10 | use Magento\Framework\Escaper;
11 | 
12 | /** @var Escaper $escaper */
13 | /** @var Template $block */
14 | /** @var RedisInfo $redisInfoViewModel */
15 | $redisInfoViewModel = $block->getData('redis_info_view_model');
16 | $redisInfo = $redisInfoViewModel->get();
17 | $redisHistory = $redisInfoViewModel->getHistoricRedisReportData();
18 | ?>
19 | <?php if (!$redisInfo): ?>
20 |     <?= $escaper->escapeHtml(__('Could not retrieve Redis information at this time.')); ?>
21 | <?php else: ?>
22 |     <?php /** Forward the Redis information to each immediate child to save them having to fetch it themselves */ ?>
23 |     <?php foreach ($block->getChildNames() as $childName): ?>
24 |         <?php $block->getChildBlock($childName)
25 |             ->setData('redis_info', $redisInfo)
26 |             ->setData('historic_redis_data', $redisHistory); ?>
27 |     <?php endforeach; ?>
28 | 
29 |     <div id="redis-info-wrapper">
30 |         <div id="misc-info">
31 |             <a href="https://redis.io/commands/info/#notes" target="_blank">
32 |                 <?= $escaper->escapeHtml(__('Redis Info Command Documentation')); ?>
33 |             </a>
34 | 
35 |             <span>
36 |                 <?= $escaper->escapeHtml(__('<b>Redis Version:</b> %1', $redisInfo['version']), ['b']); ?>
37 |             </span>
38 |         </div>
39 | 
40 |         <div id="redis-sections">
41 |             <?= /* @noEscape */ $block->getChildHtml(); ?>
42 |         </div>
43 |     </div>
44 | <?php endif; ?>
45 | 


--------------------------------------------------------------------------------
/view/adminhtml/web/css/module.css:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright © element119. All rights reserved.
 3 |  * See LICENCE.txt for licence details.
 4 |  */
 5 | /* Before Section Grid */
 6 | #misc-info {
 7 |     display: flex;
 8 |     flex-direction: column;
 9 |     margin-bottom: 2rem;
10 | }
11 | 
12 | section {
13 |     padding: 2rem 0;
14 | }
15 | 
16 | h2 {
17 |     font-weight: bold;
18 |     padding-bottom: 1rem;
19 | }
20 | 
21 | .data-list {
22 |     list-style-type: none;
23 | }
24 | 
25 | h2,
26 | .data-list {
27 |     margin: 0;
28 | }
29 | 
30 | #databases .database-info,
31 | #memory .memory-wrapper,
32 | #activity .activity-wrapper,
33 | #connections .connections-wrapper {
34 |     border: 2px solid #000000;
35 |     border-radius: 2rem;
36 |     display: flex;
37 |     margin-bottom: 3rem;
38 |     padding: 2rem;
39 | }
40 | 
41 | .database-data,
42 | .memory-data,
43 | .activity-data,
44 | .connections-data {
45 |     padding-right: 3rem;
46 | }
47 | 
48 | .database-charts,
49 | .memory-charts,
50 | .activity-charts,
51 | .connections-charts {
52 |     border-left: 1px dashed black;
53 |     padding-left: 3rem;
54 | }
55 | 
56 | .database-chart,
57 | .memory-chart,
58 | .activity-chart,
59 | .connections-chart {
60 |     padding-bottom: 5rem;
61 | }
62 | 
63 | #databases li {
64 |     padding-left: 2rem;
65 | }
66 | 


--------------------------------------------------------------------------------
/view/adminhtml/web/js/chart.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright © element119. All rights reserved.
 3 |  * See LICENCE.txt for licence details.
 4 |  */
 5 | define([
 6 |     'chartJs',
 7 | ], function (Chart) {
 8 |     'use strict';
 9 | 
10 |     return function (config, element) {
11 |         new Chart(element, {
12 |             type: config.type,
13 |             data: config.data,
14 |             options: config.options,
15 |         });
16 |     };
17 | });
18 | 


--------------------------------------------------------------------------------