Skip to content

Commit

Permalink
Merge pull request #2414 from spryker/ishakuta-performance-guildeline
Browse files Browse the repository at this point in the history
add two performance guidelines
  • Loading branch information
andriitserkovnyi authored Jan 9, 2024
2 parents 1b0d467 + de38d20 commit 9bae039
Showing 1 changed file with 22 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,6 @@ template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/performance-guidelines
originalArticleId: 5feb83b8-5196-44f9-8f6a-ffb208a2c162
redirect_from:
- /2021080/docs/performance-guidelines
- /2021080/docs/en/performance-guidelines
- /docs/performance-guidelines
- /docs/en/performance-guidelines
- /v6/docs/performance-guidelines
- /v6/docs/en/performance-guidelines
- /v5/docs/performance-guidelines
- /v5/docs/en/performance-guidelines
- /v4/docs/performance-guidelines
- /v4/docs/en/performance-guidelines
- /v3/docs/performance-guidelines
- /v3/docs/en/performance-guidelines
- /v2/docs/performance-guidelines
- /v2/docs/en/performance-guidelines
- /v1/docs/performance-guidelines
- /v1/docs/en/performance-guidelines
- /docs/scos/dev/guidelines/performance-guidelines.html
- /docs/scos/dev/tuning-up-performance/202204.0/performance-guidelines.html
related:
Expand Down Expand Up @@ -109,6 +93,27 @@ $config[\Spryker\Shared\Config\ConfigConstants::ENABLE_WEB_PROFILER] = false;

```

## Disable automatic queue creation

During the synchronization part of Publish & Sync, each time the `queue:task:start QUEUE-NAME` command is started, the RabbitMQ client tries to create all the configured queues and exchanges: `\Spryker\Client\RabbitMq\Model\Connection\Connection::__construct`. It takes up to 25% of CPU time per run. The effect becomes more significant for multi-store setups with each additional store.

For backward compatibility reasons, `RabbitMqEnv::RABBITMQ_ENABLE_RUNTIME_SETTING_UP` is enabled by default in the module configuration class: `\Spryker\Client\RabbitMq\RabbitMqConfig::isRuntimeSettingUpEnabled`. For production environments, we recommend disabling it by setting it to `false` in `config_default.php` or another config file.

Side effects:
- The application doesn't try to recreate queues and exchanges “on the fly” while interacting with RabbitMQ. If a queue is deleted, and the application attempts to access it, there will be an exception.
- The only way to create queues and exchanges to configure RabbitMQ is to run the `console queue:setup` CLI command defined in `\Spryker\Zed\RabbitMq\Communication\Console\QueueSetupConsole`. Make sure to *adjust your deploy scripts* accordingly.

## Disable INFO event logs

Publish & Sync process can work slower and generate hundreds of megabytes of `INFO`-level logs, which is good for troubleshooting and debugging, but not appropriate for production environments. By default `INFO` logs are enabled and generate about 60 MB to 100 MB per each `queue:task:run ...` execution with 80-90% of CPU time only to write logs.

There are two options to avoid this in production environments:

* Disable event logs using one of the following:
* Set `EventConstants::LOG_FILE_PATH` to `null`.
* Set `EventConstants::LOGGER_ACTIVE` to `false` in the appropriate config files, like `config_default.php`.
* Override `LoggerConfig::createStreamHandler` to change the [event logger level](https://github.com/spryker/event/blob/master/src/Spryker/Zed/Event/Business/Logger/LoggerConfig.php).

## Activate Twig compiler

Twig files can be precompiled into PHP classes to speed the performance up. This behavior can be activated in the configuration. We highly recommend using the `FORCE_BYTECODE_INVALIDATION` option. Otherwise, Opcache may contain outdated content, as the files are modified during runtime.
Expand Down Expand Up @@ -161,7 +166,7 @@ Twig files can be in many places. To avoid time-consuming searches, we recommend
## General Twig optimizations

Twig, together with [Atomic Frontend](/docs/scos/dev/front-end-development/{{site.version}}/yves/atomic-frontend/atomic-front-end-general-overview.html), is an extremely flexible approach but at the same time not the fastest one. Check if you can reduce or optimize things there.
For example, the `{% raw %}{{{% endraw %} data.foo.bar.firstName {% raw %}}}{% endraw %}` `{% raw %}{{{% endraw %} data.foo.bar.lastName {% raw %}}}{% endraw %}` trigger many calls to the `Template::getAttribute()` method which is very slow.
For example, the `{% raw %}{{{% endraw %} data.foo.bar.firstName {% raw %}}}{% endraw %}` `{% raw %}{{{% endraw %} data.foo.bar.lastName {% raw %}}}{% endraw %}` trigger many calls to the `Template::getAttribute()` method which is very slow.

Making calculations on the PHP side can help here a lot, as well as using `{% raw %}{{{% endraw %} set customer = data.foo.bar {% raw %}}}{% endraw %}` + `{% raw %}{{{% endraw %} customer.firstName {% raw %}}}{% endraw %}` `{% raw %}{{{% endraw %} customer.lastName {% raw %}}}{% endraw %}`.

Expand Down

0 comments on commit 9bae039

Please sign in to comment.