Nebulex.Adapters.Redis 🧱⚡

Nebulex adapter for Redis (including Redis Cluster support).

CICodecovHex.pmDocumentation

📖 About

This adapter uses Redix, a Redis driver for Elixir, to provide a production-ready caching solution with support for multiple deployment modes.

Key Features:

The adapter supports different configuration modes, which are explained in the following sections.

[!NOTE]

This README refers to the main branch of nebulex_redis_adapter, not the latest released version on Hex. Please reference the official documentation for the latest stable release.

🚀 Installation

Add :nebulex_redis_adapter to your list of dependencies in mix.exs:

defp deps do
  [
    {:nebulex_redis_adapter, "~> 3.0"},
    {:telemetry, "~> 1.0"},   #=> For observability/telemetry support
    {:crc, "~> 0.10"},        #=> Needed when using `:redis_cluster` mode
    {:ex_hash_ring, "~> 7.0"} #=> Needed when using `:client_side_cluster` mode
  ]
end

The adapter dependencies are optional to provide more flexibility and load only the needed ones. For example:

Then run mix deps.get to fetch the dependencies.

💻 Usage

After installing, you can define your cache to use the Redis adapter as follows:

defmodule MyApp.RedisCache do
  use Nebulex.Cache,
    otp_app: :my_app,
    adapter: Nebulex.Adapters.Redis
end

The Redis configuration is set in your application environment, usually defined in your config/config.exs:

config :my_app, MyApp.RedisCache,
  conn_opts: [
    # Redix options
    host: "127.0.0.1",
    port: 6379
  ]

Since this adapter is implemented using Redix, it inherits the same options, including regular Redis options and connection options. For more information about the options, please check out the Nebulex.Adapters.Redis module and also Redix.

See the online documentation and Redis cache example for more information.

🌐 Distributed Caching

There are different ways to support distributed caching when using Nebulex.Adapters.Redis.

🏗️ Redis Cluster

Redis Cluster is the recommended approach for production distributed caching. The adapter automatically discovers the cluster topology and routes commands to the correct shards.

Quick setup:

# 1. Define your cache
defmodule MyApp.RedisClusterCache do
  use Nebulex.Cache,
    otp_app: :my_app,
    adapter: Nebulex.Adapters.Redis
end

# 2. Configure in config/config.exs
config :my_app, MyApp.RedisClusterCache,
  mode: :redis_cluster,
  redis_cluster: [
    configuration_endpoints: [
      endpoint1_conn_opts: [
        host: "127.0.0.1",
        port: 6379,
        password: "password"
      ]
    ]
  ]

The adapter automatically:

See the Redis Cluster documentation for advanced configuration options.

🔗 Client-side Cluster

For distributing data across multiple independent Redis instances without Redis Cluster, use client-side sharding with consistent hashing.

Quick setup:

# 1. Define your cache
defmodule MyApp.ClusteredCache do
  use Nebulex.Cache,
    otp_app: :my_app,
    adapter: Nebulex.Adapters.Redis
end

# 2. Configure in config/config.exs
config :my_app, MyApp.ClusteredCache,
  mode: :client_side_cluster,
  client_side_cluster: [
    nodes: [
      node1: [pool_size: 10, conn_opts: [host: "127.0.0.1", port: 9001]],
      node2: [pool_size: 4, conn_opts: [host: "127.0.0.1", port: 9002]],
      node3: [conn_opts: [host: "127.0.0.1", port: 9003]]
    ]
  ]

The adapter uses consistent hashing to distribute keys across nodes. Each node maintains its own connection pool.

See the Client-side Cluster documentation for more configuration options.

🌉 Using a Redis Proxy

Another option is to use a proxy, such as Envoy proxy or Twemproxy, on top of Redis. In this case, the proxy handles the distribution work, and from the adapter’s side (Nebulex.Adapters.Redis), it would only require configuration. Instead of connecting the adapter to the Redis nodes, you connect it to the proxy nodes. This means in the config, you set up the pool with the host and port pointing to the proxy.

🔧 Using the Adapter as a Redis Client

The adapter provides fetch_conn/1 and fetch_conn!/1 to execute custom Redis commands using Redix, while leveraging the adapter’s connection pooling and cluster routing.

# Get a connection and execute Redis commands
iex> conn = MyCache.fetch_conn!()
iex> Redix.command!(conn, ["LPUSH", "mylist", "hello"])
1
iex> Redix.command!(conn, ["LRANGE", "mylist", "0", "-1"])
["hello"]

For cluster modes, provide a :key to ensure commands route to the correct shard/node:

iex> conn = MyCache.fetch_conn!(key: "mylist")
iex> Redix.pipeline!(conn, [
...>   ["LPUSH", "mylist", "world"],
...>   ["LRANGE", "mylist", "0", "-1"]
...> ])
[1, ["world"]]

See the Using as Redis Client documentation for encoding/ decoding helpers and advanced usage.

🧪 Testing

To run the Nebulex.Adapters.Redis tests, you will need to have Redis running locally. Nebulex.Adapters.Redis requires a complex setup for running tests (since it needs several instances running for standalone, cluster, and Redis Cluster modes). For this reason, there is a docker-compose.yml file in the repo so you can use Docker and docker-compose to spin up all the necessary Redis instances with just one command. Make sure you have Docker installed and then just run:

$ docker-compose up

Since Nebulex.Adapters.Redis uses the support modules and shared tests from Nebulex and by default its test folder is not included in the Hex dependency, the following steps are required for running the tests.

First, make sure you set the environment variable NEBULEX_PATH to nebulex:

export NEBULEX_PATH=nebulex

Second, make sure you fetch the :nebulex dependency directly from GitHub by running:

mix nbx.setup

Third, fetch the dependencies:

mix deps.get

Finally, you can run the tests:

mix test

Running tests with coverage:

mix coveralls.html

You will find the coverage report within cover/excoveralls.html.

📊 Benchmarks

Benchmarks were added using benchee; to learn more, see the benchmarks directory.

To run the benchmarks:

mix run benchmarks/benchmark.exs

Benchmarks use default Redis options (host: "127.0.0.1", port: 6379).

🤝 Contributing

Contributions to Nebulex are very welcome and appreciated!

Use the issue tracker for bug reports or feature requests. Open a pull request when you are ready to contribute.

When submitting a pull request, you should not update the CHANGELOG.md, and also make sure you test your changes thoroughly, including unit tests alongside new or changed code.

Before submitting a PR, it is highly recommended to run mix test.ci and ensure all checks run successfully.

📄 Copyright and License

Copyright (c) 2018, Carlos Bolaños.

Nebulex.Adapters.Redis source code is licensed under the MIT License.