vendor/shopware/core/Profiling/Profiler.php line 61

  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(
  39.         \Traversable $profilers,
  40.         array $activeProfilers
  41.     ) {
  42.         $profilers = iterator_to_array($profilers);
  43.         self::$profilers = array_intersect_key($profilers, array_flip($activeProfilers));
  44.         self::$tags = [];
  46.         register_shutdown_function(fn () => self::cleanup());
  47.     }
  49.     /**
  50.      * @return mixed
  51.      */
  52.     public static function trace(string $name, \Closure $closure, string $category = 'shopware', array $tags = [])
  53.     {
  54.         $tags = array_merge(self::$tags, $tags);
  56.         try {
  57.             foreach (self::$profilers as $profiler) {
  58.                 $profiler->start($name, $category, $tags);
  59.             }
  61.             $result = $closure();
  62.         } finally {
  63.             foreach (self::$profilers as $profiler) {
  64.                 $profiler->stop($name);
  65.             }
  66.         }
  68.         return $result;
  69.     }
  71.     public static function start(string $title, string $category, array $tags): void
  72.     {
  73.         self::$openTraces[] = $title;
  74.         $tags = array_merge(self::$tags, $tags);
  76.         foreach (self::$profilers as $profiler) {
  77.             $profiler->start($title, $category, $tags);
  78.         }
  79.     }
  81.     public static function stop(string $title): void
  82.     {
  83.         foreach (self::$profilers as $profiler) {
  84.             $profiler->stop($title);
  85.         }
  87.         unset(self::$openTraces[$title]);
  88.     }
  90.     public static function cleanup(): void
  91.     {
  92.         foreach (self::$openTraces as $name) {
  93.             foreach (self::$profilers as $profiler) {
  94.                 $profiler->stop($name);
  95.             }
  96.         }
  98.         self::$openTraces = [];
  99.     }
  101.     public static function addTag(string $key, string $value): void
  102.     {
  103.         self::$tags[$key] = $value;
  104.     }
  106.     public static function removeTag(string $key): void
  107.     {
  108.         unset(self::$tags[$key]);
  109.     }
  110. }