, * log_enabled: bool, * regions: array<"puts"|"hits"|"misses", array>, * }, * connections: list, * entities: array>, * errors: array>>, * managers: list, * queries: array, * runnable: bool, * types: ?array * }>>, * entityCounts: array> * } * @phpstan-type GroupedQueryItemType = array{ * executionMS: float, * explainable: bool, * sql: string, * params: ?array, * runnable: bool, * types: ?array, * count: int, * index: int, * executionPercent?: float * } * @phpstan-type GroupedQueriesType = array> * @phpstan-property DataType $data */ class DoctrineDataCollector extends BaseCollector { private int|null $invalidEntityCount = null; private int|null $managedEntityCount = null; /** * @var mixed[][]|null * @phpstan-var ?GroupedQueriesType */ private array|null $groupedQueries = null; public function __construct( private readonly ManagerRegistry $registry, private readonly bool $shouldValidateSchema = true, DebugDataHolder|null $debugDataHolder = null, ) { parent::__construct($registry, $debugDataHolder); } public function collect(Request $request, Response $response, Throwable|null $exception = null): void { parent::collect($request, $response, $exception); $errors = []; $entities = []; $entityCounts = []; $caches = [ 'enabled' => false, 'log_enabled' => false, 'counts' => [ 'puts' => 0, 'hits' => 0, 'misses' => 0, ], 'regions' => [ 'puts' => [], 'hits' => [], 'misses' => [], ], ]; foreach ($this->registry->getManagers() as $name => $em) { assert($em instanceof EntityManagerInterface); if ($this->shouldValidateSchema) { $entities[$name] = []; $factory = $em->getMetadataFactory(); $validator = new SchemaValidator($em); foreach ($factory->getLoadedMetadata() as $class) { if (isset($entities[$name][$class->getName()])) { continue; } $classErrors = $validator->validateClass($class); $r = $class->getReflectionClass(); $entities[$name][$class->getName()] = [ 'class' => $class->getName(), 'file' => $r->getFileName(), 'line' => $r->getStartLine(), ]; if (empty($classErrors)) { continue; } $errors[$name][$class->getName()] = $classErrors; } } $entityCounts[$name] = []; foreach ($em->getUnitOfWork()->getIdentityMap() as $className => $entityList) { $entityCounts[$name][$className] = count($entityList); } // Sort entities by count (in descending order) arsort($entityCounts[$name]); $emConfig = $em->getConfiguration(); $slcEnabled = $emConfig->isSecondLevelCacheEnabled(); if (! $slcEnabled) { continue; } $caches['enabled'] = true; $cacheConfiguration = $emConfig->getSecondLevelCacheConfiguration(); assert($cacheConfiguration instanceof CacheConfiguration); $cacheLoggerChain = $cacheConfiguration->getCacheLogger(); assert($cacheLoggerChain instanceof CacheLoggerChain || $cacheLoggerChain === null); if (! $cacheLoggerChain || ! $cacheLoggerChain->getLogger('statistics')) { continue; } $cacheLoggerStats = $cacheLoggerChain->getLogger('statistics'); assert($cacheLoggerStats instanceof StatisticsCacheLogger); $caches['log_enabled'] = true; $caches['counts']['puts'] += $cacheLoggerStats->getPutCount(); $caches['counts']['hits'] += $cacheLoggerStats->getHitCount(); $caches['counts']['misses'] += $cacheLoggerStats->getMissCount(); foreach ($cacheLoggerStats->getRegionsPut() as $key => $value) { if (! isset($caches['regions']['puts'][$key])) { $caches['regions']['puts'][$key] = 0; } $caches['regions']['puts'][$key] += $value; } foreach ($cacheLoggerStats->getRegionsHit() as $key => $value) { if (! isset($caches['regions']['hits'][$key])) { $caches['regions']['hits'][$key] = 0; } $caches['regions']['hits'][$key] += $value; } foreach ($cacheLoggerStats->getRegionsMiss() as $key => $value) { if (! isset($caches['regions']['misses'][$key])) { $caches['regions']['misses'][$key] = 0; } $caches['regions']['misses'][$key] += $value; } } $this->data['entities'] = $entities; $this->data['errors'] = $errors; $this->data['caches'] = $caches; $this->data['entityCounts'] = $entityCounts; $this->groupedQueries = null; } /** @return array> */ public function getEntities(): array { return $this->data['entities']; } /** @return array>> */ public function getMappingErrors(): array { return $this->data['errors']; } public function getCacheHitsCount(): int { return $this->data['caches']['counts']['hits']; } public function getCachePutsCount(): int { return $this->data['caches']['counts']['puts']; } public function getCacheMissesCount(): int { return $this->data['caches']['counts']['misses']; } public function getCacheEnabled(): bool { return $this->data['caches']['enabled']; } /** * @return array> * @phpstan-return array<"puts"|"hits"|"misses", array> */ public function getCacheRegions(): array { return $this->data['caches']['regions']; } /** @return array */ public function getCacheCounts(): array { return $this->data['caches']['counts']; } public function getInvalidEntityCount(): int { return $this->invalidEntityCount ??= array_sum(array_map('count', $this->data['errors'])); } public function getManagedEntityCount(): int { if ($this->managedEntityCount === null) { $total = 0; foreach ($this->data['entityCounts'] as $entities) { $total += array_sum($entities); } $this->managedEntityCount = $total; } return $this->managedEntityCount; } /** @return array> */ public function getManagedEntityCountByClass(): array { return $this->data['entityCounts']; } /** * @return string[][] * @phpstan-return GroupedQueriesType */ public function getGroupedQueries(): array { if ($this->groupedQueries !== null) { return $this->groupedQueries; } $this->groupedQueries = []; $totalExecutionMS = 0; foreach ($this->data['queries'] as $connection => $queries) { $connectionGroupedQueries = []; foreach ($queries as $i => $query) { $key = $query['sql']; if (! isset($connectionGroupedQueries[$key])) { $connectionGroupedQueries[$key] = $query; $connectionGroupedQueries[$key]['executionMS'] = 0; $connectionGroupedQueries[$key]['count'] = 0; $connectionGroupedQueries[$key]['index'] = $i; // "Explain query" relies on query index in 'queries'. } $connectionGroupedQueries[$key]['executionMS'] += $query['executionMS']; $connectionGroupedQueries[$key]['count']++; $totalExecutionMS += $query['executionMS']; } usort($connectionGroupedQueries, static function ($a, $b) { if ($a['executionMS'] === $b['executionMS']) { return 0; } return $a['executionMS'] < $b['executionMS'] ? 1 : -1; }); $this->groupedQueries[$connection] = $connectionGroupedQueries; } foreach ($this->groupedQueries as $connection => $queries) { foreach ($queries as $i => $query) { $this->groupedQueries[$connection][$i]['executionPercent'] = $this->executionTimePercentage($query['executionMS'], $totalExecutionMS); } } return $this->groupedQueries; } private function executionTimePercentage(float $executionTimeMS, float $totalExecutionTimeMS): float { if (! $totalExecutionTimeMS) { return 0; } return $executionTimeMS / $totalExecutionTimeMS * 100; } public function getGroupedQueryCount(): int { $count = 0; foreach ($this->getGroupedQueries() as $connectionGroupedQueries) { $count += count($connectionGroupedQueries); } return $count; } }