[PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects (Adobe-managed PaaS infrastructure) and on-premises projects only."}

Best practices for Valkey service configuration

Adobe recommends the following best practices when configuring the Valkey service:

Configure Valkey L2 cache

Configure the Valkey L2 cache by setting the VALKEY_BACKEND deployment variable in the .magento.env.yaml configuration file.

stage:
  deploy:
    VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'

For environment configuration on Cloud infrastructure, see the VALKEY_BACKEND in the Commerce on Cloud Infrastructure Guide.

For on-premises installations, see Configure Valkey page caching in the Configuration Guide.

L2 cache memory sizing (Adobe Commerce Cloud)

L2 cache uses a temporary file system as a storage mechanism. Compared with specialized key-value database systems, a temporary file system does not have a key eviction policy to control memory usage.

The lack of memory usage control can cause the L2 cache memory usage to grow over time by accumulating the stale cache.

To avoid memory exhaustion of L2 cache implementations, Adobe Commerce clears the storage when a certain threshold is reached. The default threshold value is 95%.

It is important to adjust the L2 cache memory maximum usage based on project requirements for cache storage. Use one of the following methods to configure memory cache sizing:

The following example shows a CACHE_CONFIGURATION in the .magento.env.yaml file:

stage:
  deploy:
    VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'
    CACHE_CONFIGURATION:
      _merge: true
      frontend:
        default:
          backend_options:
            cleanup_percentage: 90

Cache requirements can vary based on project configuration and custom third-party code. The scope of the L2 cache memory sizing allows the L2 cache to operate without unnecessary threshold hits.
Ideally, L2 cache memory usage should stabilize at a certain level below the threshold, to avoid frequent storage clearing.

You can check L2 cache storage memory usage on each node of the cluster using the following CLI command and then searching for the /dev/shm line.
The usage can vary across different nodes, but it should converge to the same value.

df -h

Enable Valkey slave connection

Enable a Valkey slave connection in the .magento.env.yaml configuration file to allow only one node to handle read-write traffic while the other nodes handle the read-only traffic.

stage:
  deploy:
    VALKEY_USE_SLAVE_CONNECTION: true

For more details, see VALKEY_USE_SLAVE_CONNECTION in the Commerce on Cloud Infrastructure Guide.

For Adobe Commerce on-premises installations, configure the new Valkey cache implementation using the bin/magento:setup commands. For more information, see Use Valkey for default cache in the Configuration Guide.

Pre-load keys

To reuse data between pages, list the keys for preload in the .magento.env.yaml configuration file.

stage:
  deploy:
    VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'
    CACHE_CONFIGURATION:
      _merge: true
      frontend:
        default:
          id_prefix: '061_'                       # Prefix for keys to be preloaded
          backend_options:
            preload_keys:                         # List the keys to be preloaded
              - '061_EAV_ENTITY_TYPES:hash'
              - '061_GLOBAL_PLUGIN_LIST:hash'
              - '061_DB_IS_UP_TO_DATE:hash'
              - '061_SYSTEM_DEFAULT:hash'

For on-premises installations, see Valkey preload feature in the Configuration Guide.

Enable stale cache

Reduce lock waiting times and enhance performance, especially when dealing with numerous Blocks and Cache keys,by using an outdated cache while generating a new cache in parallel. Enable the stale cache and define cache types in the .magento.env.yaml configuration file:

stage:
  deploy:
    VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'
    CACHE_CONFIGURATION:
      _merge: true
      default:
        backend_options:
          use_stale_cache: false
      stale_cache_enabled:
        backend_options:
          use_stale_cache: true
      type:
        default:
          frontend: "default"
        layout:
          frontend: "stale_cache_enabled"
        block_html:
          frontend: "stale_cache_enabled"
        reflection:
          frontend: "stale_cache_enabled"
        config_integration:
          frontend: "stale_cache_enabled"
        config_integration_api:
          frontend: "stale_cache_enabled"
        full_page:
          frontend: "stale_cache_enabled"
        translate:
          frontend: "stale_cache_enabled"

For configuring on-premises installations, see Stale cache options in the Configuration Guide.

During deployment, you should see the following lines in the build and deploy log:

W:   - Downloading colinmollenhour/credis (1.11.1)
W:   - Downloading colinmollenhour/php-redis-session-abstract (v1.4.5)
...
W:   - Installing colinmollenhour/credis (1.11.1): Extracting archive
W:   - Installing colinmollenhour/php-redis-session-abstract (v1.4.5): Extracting archive
...
[2022-08-17 01:13:40] INFO: Version of service 'valkey' is 8.0
[2022-08-17 01:13:40] INFO: Version of service 'valkey-session' is 8.0
[2022-08-17 01:13:40] INFO: valkey-session will be used for the session if it was not overridden by SESSION_CONFIGURATION.

Cache compression

If you are using over 6GB of Valkey maxmemory, you can use cache compression to reduce the space consumed by the keys. Be aware that there is a trade-off with client-side performance. If you have spare CPUs, Adobe suggests enabling them. See Use Valkey for session storage in the Configuration Guide.

stage:
  deploy:
    VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'
    CACHE_CONFIGURATION:
      _merge: true;
      frontend:
        default:
          backend_options:
            compress_data: 4              # 0-9
            compress_tags: 4              # 0-9
            compress_threshold: 20480     # do not compress files smaller than this value
            compression_lib: 'gzip'       # snappy and lzf for performance, gzip for high compression (~70%)