SncRedisBundle

SncRedisBundle provides an interface to Redis by integrating two different PHP clients:

1. PhpRedis: The native PHP extension. This is the recommended client as it is faster and the primary development platform for the bundle.
2. Predis: A pure PHP implementation. Use this as a portable alternative if the PhpRedis extension cannot be installed in your environment. The integration is designed to be functionally identical to PhpRedis.

To install RedisBundle, add it to your composer.json file. If you intend to use the predis client library, you must also install the predis/predis package.

1. Install the bundle:

composer require snc/redis-bundle

2. (Optional) Install Predis if needed:

composer require predis/predis

3. Register the bundle in your Symfony kernel:

public function registerBundles()
{
    $bundles = [
        // ...
        new Snc\RedisBundle\SncRedisBundle(),
        // ...
    ];
    ...
}

$ composer require snc/redis-bundle

To use a Redis client for Symfony App Cache or specific Cache Pools, use the client's service name (e.g., snc_redis.default) as the provider in your cache configuration.

framework:
    cache:
        app: cache.adapter.redis
        default_redis_provider: snc_redis.default
        pools:
            some-pool.cache:
                adapter: cache.adapter.redis
                provider: snc_redis.cache

To use Redis for Symfony sessions, define a Redis client and then reference its service in your framework.yaml using the RedisSessionHandler.

```yaml
# config/packages/snc_redis.yaml
snc_redis:
    clients:
        session:
            type: predis
            alias: session
            dsn: redis://localhost/1

# config/packages/framework.yaml
framework:
    session:
        handler_id: Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler

services:
    Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler:
        arguments: ['@snc_redis.session']

Note: This implementation does not perform session locking and may be subject to race conditions.

You can store Monolog logs in a Redis LIST. You must configure the Redis client with logging: false to prevent the logger from trying to log its own operations, and then define a Monolog handler that uses the client service.

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

To integrate Redis into your Symfony 6.4+ application, install the bundle using Composer.

composer require snc/redis-bundle

Configure one or more Redis clients in your config.yml under the snc_redis key. Each client requires a type (one of predis, phpredis, or relay), an alias, and a dsn.

Important: Passwords containing special characters like @, %, :, or + in the DSN string must be URL-encoded.

Services are available in the container as snc_redis.{alias}.

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

If cache warmup fails in a production environment because the Redis server is unavailable, it is likely because services are attempting to connect to Redis during the container compilation/warmup phase.

You can resolve this by installing symfony/proxy-manager-bridge. This allows certain services to be lazy-loaded, preventing unwanted connection attempts to the Redis server during the warmup process.

$ composer require symfony/proxy-manager-bridge

To set up master-slave replication using predis, provide an array of DSNs. The master connection must be tagged with the master role in its DSN for predis to function correctly.

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