vendor/symfony/cache/DataCollector/CacheDataCollector.php line 42

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Cache\DataCollector;
  14. use Symfony\Component\Cache\Adapter\TraceableAdapter;
  15. use Symfony\Component\Cache\Adapter\TraceableAdapterEvent;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\HttpKernel\DataCollector\DataCollector;
  19. use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
  21. /**
  22.  * @author Aaron Scherer <aequasi@gmail.com>
  23.  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  24.  *
  25.  * @final
  26.  */
  27. class CacheDataCollector extends DataCollector implements LateDataCollectorInterface
  28. {
  29.     /**
  30.      * @var TraceableAdapter[]
  31.      */
  32.     private $instances = [];
  34.     public function addInstance(string $name, TraceableAdapter $instance)
  35.     {
  36.         $this->instances[$name] = $instance;
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  43.     {
  44.         $empty = ['calls' => [], 'config' => [], 'options' => [], 'statistics' => []];
  45.         $this->data = ['instances' => $empty, 'total' => $empty];
  46.         foreach ($this->instances as $name => $instance) {
  47.             $this->data['instances']['calls'][$name] = $instance->getCalls();
  48.         }
  50.         $this->data['instances']['statistics'] = $this->calculateStatistics();
  51.         $this->data['total']['statistics'] = $this->calculateTotalStatistics();
  52.     }
  54.     public function reset()
  55.     {
  56.         $this->data = [];
  57.         foreach ($this->instances as $instance) {
  58.             $instance->clearCalls();
  59.         }
  60.     }
  62.     public function lateCollect()
  63.     {
  64.         $this->data['instances']['calls'] = $this->cloneVar($this->data['instances']['calls']);
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function getName(): string
  71.     {
  72.         return 'cache';
  73.     }
  75.     /**
  76.      * Method returns amount of logged Cache reads: "get" calls.
  77.      */
  78.     public function getStatistics(): array
  79.     {
  80.         return $this->data['instances']['statistics'];
  81.     }
  83.     /**
  84.      * Method returns the statistic totals.
  85.      */
  86.     public function getTotals(): array
  87.     {
  88.         return $this->data['total']['statistics'];
  89.     }
  91.     /**
  92.      * Method returns all logged Cache call objects.
  93.      *
  94.      * @return mixed
  95.      */
  96.     public function getCalls()
  97.     {
  98.         return $this->data['instances']['calls'];
  99.     }
  101.     private function calculateStatistics(): array
  102.     {
  103.         $statistics = [];
  104.         foreach ($this->data['instances']['calls'] as $name => $calls) {
  105.             $statistics[$name] = [
  106.                 'calls' => 0,
  107.                 'time' => 0,
  108.                 'reads' => 0,
  109.                 'writes' => 0,
  110.                 'deletes' => 0,
  111.                 'hits' => 0,
  112.                 'misses' => 0,
  113.             ];
  114.             /** @var TraceableAdapterEvent $call */
  115.             foreach ($calls as $call) {
  116.                 ++$statistics[$name]['calls'];
  117.                 $statistics[$name]['time'] += $call->end - $call->start;
  118.                 if ('get' === $call->name) {
  119.                     ++$statistics[$name]['reads'];
  120.                     if ($call->hits) {
  121.                         ++$statistics[$name]['hits'];
  122.                     } else {
  123.                         ++$statistics[$name]['misses'];
  124.                         ++$statistics[$name]['writes'];
  125.                     }
  126.                 } elseif ('getItem' === $call->name) {
  127.                     ++$statistics[$name]['reads'];
  128.                     if ($call->hits) {
  129.                         ++$statistics[$name]['hits'];
  130.                     } else {
  131.                         ++$statistics[$name]['misses'];
  132.                     }
  133.                 } elseif ('getItems' === $call->name) {
  134.                     $statistics[$name]['reads'] += $call->hits + $call->misses;
  135.                     $statistics[$name]['hits'] += $call->hits;
  136.                     $statistics[$name]['misses'] += $call->misses;
  137.                 } elseif ('hasItem' === $call->name) {
  138.                     ++$statistics[$name]['reads'];
  139.                     if (false === $call->result) {
  140.                         ++$statistics[$name]['misses'];
  141.                     } else {
  142.                         ++$statistics[$name]['hits'];
  143.                     }
  144.                 } elseif ('save' === $call->name) {
  145.                     ++$statistics[$name]['writes'];
  146.                 } elseif ('deleteItem' === $call->name) {
  147.                     ++$statistics[$name]['deletes'];
  148.                 }
  149.             }
  150.             if ($statistics[$name]['reads']) {
  151.                 $statistics[$name]['hit_read_ratio'] = round(100 * $statistics[$name]['hits'] / $statistics[$name]['reads'], 2);
  152.             } else {
  153.                 $statistics[$name]['hit_read_ratio'] = null;
  154.             }
  155.         }
  157.         return $statistics;
  158.     }
  160.     private function calculateTotalStatistics(): array
  161.     {
  162.         $statistics = $this->getStatistics();
  163.         $totals = [
  164.             'calls' => 0,
  165.             'time' => 0,
  166.             'reads' => 0,
  167.             'writes' => 0,
  168.             'deletes' => 0,
  169.             'hits' => 0,
  170.             'misses' => 0,
  171.         ];
  172.         foreach ($statistics as $name => $values) {
  173.             foreach ($totals as $key => $value) {
  174.                 $totals[$key] += $statistics[$name][$key];
  175.             }
  176.         }
  177.         if ($totals['reads']) {
  178.             $totals['hit_read_ratio'] = round(100 * $totals['hits'] / $totals['reads'], 2);
  179.         } else {
  180.             $totals['hit_read_ratio'] = null;
  181.         }
  183.         return $totals;
  184.     }
  185. }