feat: add checks for PHP FPM when not in cluster mode (#336)

Author: tinect

phpstan.neon.dist

@@ -3,3 +3,6 @@ parameters:
     paths:
         - src
     reportUnmatchedIgnoredErrors: false
+    ignoreErrors:
+        -
+            message: "#no value type specified in iterable type array#"

src/Components/Health/Checker/HealthChecker/PhpChecker.php

@@ -7,6 +7,7 @@
 use Frosh\Tools\Components\Health\Checker\CheckerInterface;
 use Frosh\Tools\Components\Health\HealthCollection;
 use Frosh\Tools\Components\Health\SettingsResult;
+use Frosh\Tools\FroshTools;
 
 class PhpChecker implements HealthCheckerInterface, CheckerInterface
 {
@@ -19,14 +20,6 @@ public function collect(HealthCollection $collection): void
         $this->checkPcreJitActive($collection);
     }
 
-    private function formatSize(float $size): string
-    {
-        $base = log($size) / log(1024);
-        $suffix = ['', 'k', 'M', 'G', 'T'][floor($base)];
-
-        return (1024 ** ($base - floor($base))) . $suffix;
-    }
-
     private function checkPhp(HealthCollection $collection): void
     {
         $minPhpVersion = '8.2.0';
@@ -90,8 +83,8 @@ private function checkMemoryLimit(HealthCollection $collection): void
                 SettingsResult::error(
                     'php-memory-limit',
                     'Memory-Limit',
-                    $this->formatSize($currentMemoryLimit),
-                    'min ' . $this->formatSize($minMemoryLimit),
+                    FroshTools::formatSize($currentMemoryLimit),
+                    'min ' . FroshTools::formatSize($minMemoryLimit),
                 ),
             );
 
@@ -101,8 +94,8 @@ private function checkMemoryLimit(HealthCollection $collection): void
         $collection->add(SettingsResult::ok(
             'php-memory-limit',
             'Memory-Limit',
-            $this->formatSize($currentMemoryLimit),
-            'min ' . $this->formatSize($minMemoryLimit),
+            FroshTools::formatSize($currentMemoryLimit),
+            'min ' . FroshTools::formatSize($minMemoryLimit),
         ));
     }
 

src/Components/Health/Checker/HealthChecker/PhpFpmChecker.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Frosh\Tools\Components\Health\Checker\HealthChecker;
+
+use Frosh\Tools\Components\Health\Checker\CheckerInterface;
+use Frosh\Tools\Components\Health\HealthCollection;
+use Frosh\Tools\Components\Health\SettingsResult;
+use Frosh\Tools\FroshTools;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+class PhpFpmChecker implements HealthCheckerInterface, CheckerInterface
+{
+    public function __construct(
+        #[Autowire(param: 'shopware.deployment.cluster_setup')]
+        private readonly bool $clusterSetup,
+    ) {
+    }
+
+    public function collect(HealthCollection $collection): void
+    {
+        if ($this->clusterSetup) {
+            return;
+        }
+
+        if (\function_exists('fpm_get_status') === false) {
+            return;
+        }
+
+        $fpmStatus = \fpm_get_status();
+
+        if ($fpmStatus === false) {
+            return;
+        }
+
+        $this->checkListenQueue($fpmStatus, $collection);
+        $this->checkMaxChildren($fpmStatus, $collection);
+        $this->checkMemoryPeak($fpmStatus, $collection);
+    }
+
+    private function checkListenQueue(array $fpmStatus, HealthCollection $collection): void
+    {
+        $listenQueue = $fpmStatus['max-listen-queue'] ?? 0;
+
+        $status = SettingsResult::ok(
+            'php-fpm-max-listen-queue',
+            'PHP FPM max listen queue',
+            (string) $listenQueue,
+            '0',
+            'https://www.php.net/manual/en/fpm.status.php#:~:text=a%20free%20process.-,max%20listen%20queue,-The%20maximum%20number'
+        );
+
+        if ($listenQueue > 0) {
+            $status->state = SettingsResult::WARNING;
+        }
+
+        $collection->add($status);
+    }
+
+    private function checkMaxChildren(array $fpmStatus, HealthCollection $collection): void
+    {
+        $maxChildrenReached = (bool) ($fpmStatus['max-children-reached'] ?? false);
+
+        $status = SettingsResult::ok(
+            'php-fpm-max-children-reached',
+            'PHP FPM max children reached',
+            $maxChildrenReached ? 'yes' : 'no',
+            'no',
+            'https://www.php.net/manual/en/fpm.status.php#:~:text=max%20children%20reached'
+        );
+
+        if ($maxChildrenReached) {
+            $status->state = SettingsResult::WARNING;
+        }
+
+        $collection->add($status);
+    }
+
+    private function checkMemoryPeak(array $fpmStatus, HealthCollection $collection): void
+    {
+        // Skip this check if memory-peak is not available (PHP < 8.4)
+        if (!isset($fpmStatus['memory-peak'])) {
+            return;
+        }
+
+        $memoryPeak = $fpmStatus['memory-peak'];
+        $memoryPeak = FroshTools::formatSize($memoryPeak);
+
+        $collection->add(
+            SettingsResult::ok(
+                'php-fpm-memory-peak',
+                'PHP FPM memory peak',
+                $memoryPeak,
+                '',
+                'https://www.php.net/manual/en/fpm.status.php#:~:text=memory%20peak'
+            )
+        );
+    }
+}

src/FroshTools.php

@@ -21,6 +21,18 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new DisableElasticsearchCompilerPass());
     }
 
+    public static function formatSize(float $size): string
+    {
+        if ($size <= 0) {
+            return '0';
+        }
+
+        $base = log($size) / log(1024);
+        $suffix = ['', 'k', 'M', 'G', 'T'][floor($base)];
+
+        return round(1024 ** ($base - floor($base)), 2) . $suffix;
+    }
+
     protected function createContainerExtension(): FroshToolsExtension
     {
         return new FroshToolsExtension();