example.rst

Redis filter

Requirements

In this example, we show how a :ref:`Redis filter <config_network_filters_redis_proxy>` can be used with the Envoy proxy.

The Envoy proxy configuration includes a Redis filter that routes egress requests to redis server.

Note

The example uses a redis container as the client but you could use a local redis client instead.

Step 1: Build the sandbox

Change to the redis directory.

Build and start the containers.

$ pwd
examples/redis
$ docker compose pull
$ docker compose up --build -d
$ docker compose ps

    Name                   Command               State                             Ports
------------------------------------------------------------------------------------------------------------------
redis_proxy_1   /docker-entrypoint.sh /bin       Up      10000/tcp, 0.0.0.0:1999->1999/tcp, 0.0.0.0:8001->8001/tcp
redis_redis_1   docker-entrypoint.sh redis       Up      6379/tcp

Step 2: Issue Redis commands

Issue Redis commands using your favourite Redis client, such as redis-cli, and verify they are routed via Envoy.

$ docker run --rm --network host redis:latest redis-cli -h localhost -p 1999 set foo foo
OK
$ docker run --rm --network host redis:latest redis-cli -h localhost -p 1999 set bar bar
OK
$ docker run --rm --network host redis:latest redis-cli -h localhost -p 1999 get foo
"foo"
$ docker run --rm --network host redis:latest redis-cli -h localhost -p 1999 get bar
"bar"

Step 3: Verify egress stats

Go to http://localhost:8001/stats?usedonly&filter=redis.egress_redis.command and verify the following stats:

redis.egress_redis.command.get.total: 2
redis.egress_redis.command.set.total: 2

.. seealso::

   :ref:`Envoy Redis filter <config_network_filters_redis_proxy>`
      Learn more about using the Envoy Redis filter.

   :ref:`Envoy admin quick start guide <start_quick_start_admin>`
      Quick start guide to the Envoy admin interface.

   `Redis <https://redis.io>`_
      The Redis in-memory data structure store.