src/Core/Profiling/Profiler.php line 59

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Profiling;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\Profiling\Integration\ProfilerInterface;
  8. /**
  9.  * @internal experimental atm
  10.  */
  11. #[Package('core')]
  12. class Profiler
  13. {
  14.     /**
  15.      * Profilers will be activated over the shopware.yaml file
  16.      *
  17.      * All enabled profilers will be added here
  18.      *
  19.      * @var ProfilerInterface[]
  20.      */
  21.     private static array $profilers = [];
  23.     /**
  24.      * Tags will be added to each trace
  25.      *
  26.      * @var array<string>
  27.      */
  28.     private static array $tags = [];
  30.     /**
  31.      * @var array<string>
  32.      */
  33.     private static array $openTraces = [];
  35.     /**
  36.      * @param array<string> $activeProfilers
  37.      */
  38.     public function __construct(\Traversable $profilers, array $activeProfilers)
  39.     {
  40.         $profilers = iterator_to_array($profilers);
  41.         self::$profilers = array_intersect_key($profilers, array_flip($activeProfilers));
  42.         self::$tags = [];
  44.         register_shutdown_function(fn () => self::cleanup());
  45.     }
  47.     /**
  48.      * @return mixed
  49.      */
  50.     public static function trace(string $name, \Closure $closure, string $category = 'shopware', array $tags = [])
  51.     {
  52.         $tags = array_merge(self::$tags, $tags);
  54.         try {
  55.             foreach (self::$profilers as $profiler) {
  56.                 $profiler->start($name, $category, $tags);
  57.             }
  59.             $result = $closure();
  60.         } finally {
  61.             foreach (self::$profilers as $profiler) {
  62.                 $profiler->stop($name);
  63.             }
  64.         }
  66.         return $result;
  67.     }
  69.     public static function start(string $title, string $category, array $tags): void
  70.     {
  71.         self::$openTraces[] = $title;
  72.         $tags = array_merge(self::$tags, $tags);
  74.         foreach (self::$profilers as $profiler) {
  75.             $profiler->start($title, $category, $tags);
  76.         }
  77.     }
  79.     public static function stop(string $title): void
  80.     {
  81.         foreach (self::$profilers as $profiler) {
  82.             $profiler->stop($title);
  83.         }
  85.         unset(self::$openTraces[$title]);
  86.     }
  88.     public static function cleanup(): void
  89.     {
  90.         foreach (self::$openTraces as $name) {
  91.             foreach (self::$profilers as $profiler) {
  92.                 $profiler->stop($name);
  93.             }
  94.         }
  96.         self::$openTraces = [];
  97.     }
  99.     public static function addTag(string $key, string $value): void
  100.     {
  101.         self::$tags[$key] = $value;
  102.     }
  104.     public static function removeTag(string $key): void
  105.     {
  106.         unset(self::$tags[$key]);
  107.     }
  108. }