Performance

Par défaut, FrankenPHP essaie d’offrir un bon compromis entre performance et facilité d’utilisation. Cependant, il est possible d’améliorer considérablement les performances en utilisant une configuration appropriée.

Par défaut, FrankenPHP démarre deux fois plus de threads et de workers (en mode worker) que le nombre de cœurs de CPU disponibles.

Les valeurs appropriées dépendent fortement de la manière dont votre application est écrite, de ce qu’elle fait et de votre matériel. Nous recommandons vivement de modifier ces valeurs. Pour une stabilité optimale du système, il est recommandé d’avoir num_threads x memory_limit < available_memory.

Pour trouver les bonnes valeurs, il est préférable d’effectuer des tests de charge simulant le trafic réel. k6 et Gatling sont de bons outils pour cela.

Pour configurer le nombre de threads, utilisez l’option num_threads des directives php_server et php. Pour changer le nombre de workers, utilisez l’option num de la section worker de la directive frankenphp.

Bien qu’il soit toujours préférable de savoir exactement à quoi ressemblera votre trafic, les applications réelles ont tendance à être plus imprévisibles. La configuration max_threads permet à FrankenPHP de créer automatiquement des threads supplémentaires au moment de l’exécution, jusqu’à la limite spécifiée. max_threads peut vous aider à déterminer le nombre de threads dont vous avez besoin pour gérer votre trafic et peut rendre le serveur plus résistant aux pics de latence. Si elle est fixée à auto, la limite sera estimée en fonction de la valeur de memory_limit dans votre php.ini. Si ce n’est pas possible, auto prendra par défaut 2x num_threads. Gardez à l’esprit que auto peut fortement sous-estimer le nombre de threads nécessaires. max_threads est similaire à pm.max_children de PHP FPM. La principale différence est que FrankenPHP utilise des threads au lieu de processus et les délègue automatiquement à différents scripts worker et au ‘mode classique’ selon les besoins.

Activer le mode worker améliore considérablement les performances, mais votre application doit être adaptée pour être compatible avec ce mode : vous devez créer un script worker et vous assurer que l’application n’a pas de fuite de mémoire.

La variante Alpine Linux des images Docker officielles et les binaires par défaut que nous fournissons utilisent la bibliothèque musl.

PHP est connu pour être plus lent lorsqu’il utilise cette bibliothèque C alternative au lieu de la bibliothèque GNU traditionnelle, surtout lorsqu’il est compilé en mode ZTS (thread-safe), ce qui est nécessaire pour FrankenPHP. La différence peut être significative dans un environnement fortement multithreadé.

En outre, certains bogues ne se produisent que lors de l’utilisation de musl.

Dans les environnements de production, nous recommandons d’utiliser FrankenPHP lié à glibc, compilé avec un niveau d’optimisation approprié.

Cela peut être réalisé en utilisant les images Docker Debian, en utilisant les paquets .deb, .rpm ou .apk proposés par l’un de nos mainteneurs, ou en compilant FrankenPHP à partir des sources.

Pour des conteneurs plus légers ou plus sécurisés, vous pourriez envisager une image Debian renforcée plutôt qu’Alpine.

FrankenPHP est écrit en Go.

En général, le runtime Go ne nécessite pas de configuration particulière, mais dans certaines circonstances, une configuration spécifique améliore les performances.

Vous voudrez probablement mettre la variable d’environnement GODEBUG à cgocheck=0 (la valeur par défaut dans les images Docker de FrankenPHP).

Si vous exécutez FrankenPHP dans des conteneurs (Docker, Kubernetes, LXC…) et que vous limitez la mémoire disponible pour les conteneurs, mettez la variable d’environnement GOMEMLIMIT à la quantité de mémoire disponible.

Pour plus de détails, la page de documentation Go dédiée à ce sujet est à lire absolument pour tirer le meilleur parti du runtime.

Par défaut, la directive php_server met automatiquement en place un serveur de fichiers pour servir les fichiers statiques (assets) stockés dans le répertoire racine.

Cette fonctionnalité est pratique, mais a un coût. Pour la désactiver, utilisez la configuration suivante :

php_server {
    file_server off
}

En plus des fichiers statiques et des fichiers PHP, php_server essaiera aussi de servir les fichiers d’index et d’index de répertoire de votre application (/path/ -> /path/index.php). Si vous n’avez pas besoin des index de répertoires, vous pouvez les désactiver en définissant explicitement try_files comme ceci :

php_server {
    try_files {path} index.php
    root /root/to/your/app # l'ajout explicite de la racine ici permet une meilleure mise en cache
}

Cela permet de réduire considérablement le nombre d’opérations inutiles sur les fichiers. Un équivalent worker de la configuration précédente serait :

route {
    php_server { # utilisez "php" au lieu de "php_server" si vous n'avez pas du tout besoin du serveur de fichiers
        root /root/to/your/app
        worker /path/to/worker.php {
            match * # envoie toutes les requêtes directement au worker
        }
    }
}

Une approche alternative avec 0 opérations inutiles sur le système de fichiers serait d’utiliser la directive php et de diviser les fichiers de PHP par chemin. Cette approche fonctionne bien si votre application entière est servie par un seul fichier d’entrée. Un exemple de configuration qui sert des fichiers statiques derrière un dossier /assets pourrait ressembler à ceci :

route {
    @assets {
        path /assets/*
    }

    # tout ce qui se trouve derrière /assets est géré par le serveur de fichiers
    file_server @assets {
        root /root/to/your/app
    }

    # tout ce qui n'est pas dans /assets est géré par votre fichier PHP d'index ou worker
    rewrite index.php
    php {
        root /root/to/your/app # l'ajout explicite de la racine ici permet une meilleure mise en cache
    }
}

Vous pouvez utiliser des placeholders dans les directives root et env. Cependant, cela empêche la mise en cache de ces valeurs et a un coût important en termes de performances.

Si possible, évitez les placeholders dans ces directives.

Par défaut, si le document root est un lien symbolique, il est automatiquement résolu par FrankenPHP (c’est nécessaire pour le bon fonctionnement de PHP). Si la racine du document n’est pas un lien symbolique, vous pouvez désactiver cette fonctionnalité.

php_server {
    resolve_root_symlink false
}

Cela améliorera les performances si la directive root contient des placeholders. Le gain sera négligeable dans les autres cas.

La journalisation est évidemment très utile, mais, par définition, elle nécessite des opérations d’I/O et des allocations de mémoire, ce qui réduit considérablement les performances. Assurez-vous de définir le niveau de journalisation correctement, et de ne journaliser que ce qui est nécessaire.

FrankenPHP utilise l’interpréteur PHP officiel. Toutes les optimisations de performances habituelles liées à PHP s’appliquent à FrankenPHP.

En particulier :

• vérifiez que OPcache est installé, activé et correctement configuré
• activez les optimisations de l’autoloader de Composer
• assurez-vous que le cache realpath est suffisamment grand pour les besoins de votre application
• utilisez le pré-chargement

Pour plus de détails, lisez l’entrée de la documentation dédiée de Symfony (la plupart des conseils sont utiles même si vous n’utilisez pas Symfony).

Il est courant que les applications interagissent avec des services externes lents, comme une API qui a tendance à être peu fiable sous forte charge ou qui met constamment plus de 10 secondes à répondre. Dans de tels cas, il peut être bénéfique de diviser le pool de threads pour avoir des pools “lents” dédiés. Cela empêche les points d’accès lents de consommer toutes les ressources/threads du serveur et limite la concurrence des requêtes se dirigeant vers le point d’accès lent, à l’instar d’un pool de connexions.

example.com {
    php_server {
        root /app/public # la racine de votre application
        worker index.php {
            match /slow-endpoint/* # toutes les requêtes avec le chemin /slow-endpoint/* sont gérées par ce pool de threads
            num 1 # minimum 1 thread pour les requêtes correspondant à /slow-endpoint/*
            max_threads 20 # autorise jusqu'à 20 threads pour les requêtes correspondant à /slow-endpoint/*, si nécessaire
        }
        worker index.php {
            match * # toutes les autres requêtes sont gérées séparément
            num 1 # minimum 1 thread pour les autres requêtes, même si les points d'accès lents commencent à bloquer
            max_threads 20 # autorise jusqu'à 20 threads pour les autres requêtes, si nécessaire
        }
    }
}

De manière générale, il est également conseillé de gérer les points d’accès très lents de manière asynchrone, en utilisant des mécanismes pertinents tels que les files d’attente de messages.