CacheDataCollector.php 5.4 KB

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