index.md

RedisBundle

About

This bundle integrates Predis and phpredis into your Symfony application.

Prerequisite

Session handler requires Redis >= 2.6.12 for LUA scripts and SET with options.

Installation

Add the snc/redis-bundle package to your require section in the composer.json file.

$ composer require snc/redis-bundle 2.x-dev

If you want to use the predis client library, you have to add the predis/predis package, too.

$ composer require predis/predis ^1.0

Add the RedisBundle to your application's kernel:

<?php
public function registerBundles()
{
    $bundles = array(
        // ...
        new Snc\RedisBundle\SncRedisBundle(),
        // ...
    );
    ...
}

Usage

Configure the redis client(s) in your config.yml:

Please note that passwords with special characters in the DSN string such as @ % : + must be urlencoded.

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn: redis://localhost

You have to configure at least one client. In the above example your service container will contain the service snc_redis.default which will return a Predis client.

Available types are predis and phpredis.

A more complex setup which contains a clustered client could look like this:

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn: redis://localhost
            logging: '%kernel.debug%'
        cache:
            type: predis
            alias: cache
            dsn: redis://secret@localhost/1
            options:
                profile: 2.2
                connection_timeout: 10
                read_write_timeout: 30
        session:
            type: predis
            alias: session
            dsn: redis://localhost/2
        cluster:
            type: predis
            alias: cluster
            dsn:
                - redis://localhost/3?weight=10
                - redis://localhost/4?weight=5
                - redis://localhost/5?weight=1

In your code you can now access all your configured clients using dependency injection or service locators. The services are named snc_redis. followed by the alias name, ie. snc_redis.default or snc_redis.cluster in the example above.

A setup using predis master-slave replication could look like this:

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn:
                - redis://master-host?alias=master
                - redis://slave-host1
                - redis://slave-host2
            options:
                replication: true

Please note that the master dsn connection needs to be tagged with the master alias. If not, predis will complain.

A setup using predis sentinel replication could look like this:

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn:
                - redis://localhost:26379
                - redis://otherhost:26379
            options:
                replication: sentinel
                service: mymaster
                parameters:
                    database: 1
                    password: pass

The service is the name of the set of Redis instances. The optional parameters option can be used to set parameters like the database number and password for the master/slave connections, they don't apply for the connection to sentinel. If you use a password, it must be in the password parameter and must be omitted from the DSNs. Also make sure to use the sentinel port number (26379 by default) in the DSNs, and not the default Redis port. You can find more information about this on Configuring Sentinel.

A setup using RedisCluster from phpredis could look like this:

snc_redis:
    clients:
        default:
            type: phpredis
            alias: default
            dsn:
                - redis://localhost:7000
                - redis://localhost:7001
                - redis://localhost:7002
            options:
                cluster: true

Sessions

Use Redis sessions by adding the following to your config:

snc_redis:
    ...
    session:
        client: session

This bundle then provides the snc_redis.session.handler service which you have to activate at framework.session.handler_id:

framework:
    ...
    session:
        handler_id: snc_redis.session.handler

This will use the default prefix session.

You may specify another prefix:

snc_redis:
    ...
    session:
        client: session
        prefix: foo

By default, a TTL is set using the framework.session.cookie_lifetime parameter. But you can override it using the ttl option:

snc_redis:
    ...
    session:
        client: session
        ttl: 1200

This will make session data expire after 20 minutes, on the server side. This is highly recommended if you don't set an expiration date to the session cookie. Note that using Redis for storing sessions is a good solution to avoid garbage collection of sessions by PHP.

Doctrine caching

Use Redis caching for Doctrine by adding this to your config:

snc_redis:
    ...
    doctrine:
        metadata_cache:
            client: cache
            entity_manager: default          # the name of your entity_manager connection
            document_manager: default        # the name of your document_manager connection
        result_cache:
            client: cache
            entity_manager: [default, read]  # you may specify multiple entity_managers
        query_cache:
            client: cache
            entity_manager: default
        second_level_cache:
            client: cache
            entity_manager: default

Monolog logging

You can store your logs in a redis LIST by adding this to your config:

snc_redis:
    clients:
        monolog:
            type: predis
            alias: monolog
            dsn: redis://localhost/1
            logging: false
            options:
                connection_persistent: true
    monolog:
        client: monolog
        key: monolog

monolog:
    handlers:
        main:
            type: service
            id: snc_redis.monolog.handler
            level: debug

You can also add a custom formatter to the monolog handler

snc_redis:
    clients:
        monolog:
            type: predis
            alias: monolog
            dsn: redis://localhost/1
            logging: false
            options:
                connection_persistent: true
    monolog:
        client: monolog
        key: monolog
        formatter: my_custom_formatter

SwiftMailer spooling

You can spool your mails in a redis LIST by adding this to your config:

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn: redis://localhost
            logging: false
    swiftmailer:
        client: default
        key: swiftmailer

Additionally you have to configure the swiftmailer spool:

Since version 2.2.6 and 2.3.4 of the SwiftmailerBundle you can configure custom spool implementations using the service type:

swiftmailer:
    ...
    spool:
        type: service
        id: snc_redis.swiftmailer.spool

If you are using an older version of the SwiftmailerBundle the following configuration should work, but this was kind of a hack:

swiftmailer:
    ...
    spool:
        type: redis

Symfony Cache Pools

If you want to use one of the client connections for the Symfony App Cache or a Symfony Cache Pool, just use its service name as a cache pool provider:

framework:
    cache:
        app: cache.adapter.redis
        # app cache from client config as default adapter/provider
        default_redis_provider: snc_redis.default
    pools:
        some-pool.cache:
            adapter: cache.adapter.redis
            # a specific provider, e.g. if you have a snc_redis.clients.cache
            provider: snc_redis.cache

Profiler storage

⚠️ this feature is not supported anymore since Symfony 4.4 and will be automatically disabled if you are using Symfony 4.4.

As the profiler must only be used on non-production servers, the file storage is more than enough and no other implementations will ever be supported.

Complete configuration example

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn: redis://localhost
            logging: '%kernel.debug%'
        cache:
            type: predis
            alias: cache
            dsn: redis://localhost/1
            logging: false
        cluster:
            type: predis
            alias: cluster
            dsn:
                - redis://127.0.0.1/1
                - redis://127.0.0.2/2
                - redis://pw@/var/run/redis/redis-1.sock/10
                - redis://pw@127.0.0.1:63790/10
            options:
                prefix: foo
                profile: 2.4
                connection_timeout: 10
                connection_persistent: true
                read_write_timeout: 30
                iterable_multibulk: false
                throw_errors: true
                cluster: predis
    session:
        client: default
        prefix: foo
    doctrine:
        metadata_cache:
            client: cache
            entity_manager: default
            document_manager: default
        result_cache:
            client: cache
            entity_manager: [default, read]
            document_manager: [default, slave1, slave2]
            namespace: "dcrc:"
        query_cache:
            client: cache
            entity_manager: default
        second_level_cache:
            client: cache
            entity_manager: default
    monolog:
        client: cache
        key: monolog
    swiftmailer:
        client: default
        key: swiftmailer

Usage with symfony/web-profiler-bundle

If you are using symfony/web-profiler-bundle and want to inspect commands sent by a configured Redis client, logging needs to be enabled for that client.

snc_redis:
    clients:
        default:
            type: predis
            alias: default
            dsn: redis://localhost/
            logging: '%kernel.debug%'

Troubleshooting

If cache warmup fails for prod because a redis server is not available, try to install symfony/proxy-manager-bridge:

$ composer require symfony/proxy-manager-bridge

Once done some services will be lazy-loaded and could prevent unwanted connection call.