Symfony is fast, right out of the box. However, you can make it faster if you optimize your servers and your applications as explained in the following performance checklists.
Symfony Application Checklist¶
These are the code and configuration changes that you can make in your Symfony application to improve its performance:
- Install APCu Polyfill if your server uses APC
- Dump the service container into a single file
- Restrict the number of locales enabled in the application
Install APCu Polyfill if your Server Uses APC¶
If your production server still uses the legacy APC PHP extension instead of OPcache, install the APCu Polyfill component in your application to enable compatibility with APCu PHP functions and unlock support for advanced Symfony features, such as the APCu Cache adapter.
Dump the Service Container into a Single File¶
Symfony compiles the service container into multiple
small files by default. Set this parameter to
true to compile the entire
container into a single file, which could improve performance when using
“class preloading” in PHP 7.4 or newer versions:
1 2 3 4
# config/services.yaml parameters: # ... container.dumper.inline_factories: true
1 2 3 4 5 6 7 8 9 10 11
<!-- config/services.xml --> <?xml version="1.0" encoding="UTF-8" ?> <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd"> <parameters> <!-- ... --> <parameter key="container.dumper.inline_factories">true</parameter> </parameters> </container>
1 2 3 4
// config/services.php // ... $container->setParameter('container.dumper.inline_factories', true);
Production Server Checklist¶
These are the changes that you can make in your production server to improve performance when running Symfony applications:
- Use the OPcache byte code cache
- Use the OPcache class preloading
- Configure OPcache for maximum performance
- Don’t check PHP files timestamps
- Configure the PHP realpath Cache
- Optimize Composer Autoloader
Use the OPcache Byte Code Cache¶
OPcache stores the compiled PHP files to avoid having to recompile them for every request. There are some byte code caches available, but as of PHP 5.5, PHP comes with OPcache built-in. For older versions, the most widely used byte code cache is APC.
Use the OPcache class preloading¶
Starting from PHP 7.4, OPcache can compile and load classes at start-up and make them available to all requests until the server is restarted, improving performance significantly.
During container compilation (e.g. when running the
Symfony generates a file called
.preload (with a leading
.) in the
src/ directory with the list of classes to preload.
The only requirement is that you need to set both
container.dumper.inline_class_loader parameters to
true. Then, you
can configure PHP to use this preload file:
; php.ini opcache.preload=/path/to/project/src/.preload.php
Configure OPcache for Maximum Performance¶
The default OPcache configuration is not suited for Symfony applications, so it’s recommended to change these settings as follows:
1 2 3 4 5 6
; php.ini ; maximum memory that OPcache can use to store compiled PHP files opcache.memory_consumption=256 ; maximum number of files that can be stored in the cache opcache.max_accelerated_files=20000
Don’t Check PHP Files Timestamps¶
In production servers, PHP files should never change, unless a new application version is deployed. However, by default OPcache checks if cached files have changed their contents since they were cached. This check introduces some overhead that can be avoided as follows:
; php.ini opcache.validate_timestamps=0
After each deploy, you must empty and regenerate the cache of OPcache. Otherwise you won’t see the updates made in the application. Given that in PHP, the CLI and the web processes don’t share the same OPcache, you cannot clear the web server OPcache by executing some command in your terminal. These are some of the possible solutions:
- Restart the web server;
- Call the
opcache_reset()functions via the web server (i.e. by having these in a script that you execute over the web);
- Use the cachetool utility to control APC and OPcache from the CLI.
Configure the PHP
When a relative path is transformed into its real and absolute path, PHP caches the result to improve performance. Applications that open many PHP files, such as Symfony projects, should use at least these values:
1 2 3 4 5 6
; php.ini ; maximum memory allocated to store the results realpath_cache_size=4096K ; save the results for 10 minutes (600 seconds) realpath_cache_ttl=600
PHP disables the
realpath cache when the open_basedir config option
Optimize Composer Autoloader¶
The class loader used while developing the application is optimized to find
new and changed classes. In production servers, PHP files should never change,
unless a new application version is deployed. That’s why you can optimize
Composer’s autoloader to scan the entire application once and build a “class map”,
which is a big array of the locations of all the classes and it’s stored
Execute this command to generate the class map (and make it part of your deployment process too):
$ composer dump-autoload --no-dev --classmap-authoritative
--no-devexcludes the classes that are only needed in the development environment (i.e.
--classmap-authoritativecreates a class map for PSR-0 and PSR-4 compatible classes used in your application and prevents Composer from scanning the file system for classes that are not found in the class map. (see: Composer’s autoloader optimization).
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.