Redis Caching & Messaging (Pub/Sub, Streams) · Lesson

Distributed Locks with Redis

Implement reliable distributed locking mechanisms using Redis to coordinate access in concurrent systems.

Distributed Locks with Redis is a free Redis Caching & Messaging (Pub/Sub, Streams) lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Redis Caching & Messaging (Pub/Sub, Streams) learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

The Need for Distributed Locks

Imagine multiple applications or services trying to update the same piece of data, like a user's balance or a unique order ID. Without coordination, they could overwrite each other's changes, leading to data corruption or incorrect states.

Race conditions: When operations depend on specific timing, leading to unpredictable results.
Data integrity: Ensuring shared resources remain consistent.
Concurrency control: Managing access when multiple processes run simultaneously.

Distributed locks are like a single key to a shared room. Only one process can hold the key (lock) at a time, ensuring exclusive access.

Why Redis for Distributed Locks?

Redis is an excellent choice for implementing distributed locks due to its speed, atomic operations, and single-threaded nature.

Atomicity: Redis commands are executed atomically, meaning they complete entirely or not at all, preventing partial updates.
Performance: In-memory operations ensure very low latency for lock acquisition and release.
Simplicity: Basic string commands can be leveraged effectively for locking.

These features allow Redis to manage lock states reliably and efficiently across many different application instances.

Basic Lock Acquisition (SET NX EX)

The core of a Redis-based lock lies in the SET command with specific options:

NX (Not eXists): Ensures the key is only set if it doesn't already exist. This is how we acquire the lock exclusively.
EX (EXpire): Sets an expiration time for the key in seconds. This is crucial to prevent deadlocks if a client crashes before releasing the lock.
value: A unique identifier for the lock holder (e.g., a UUID). This allows only the original lock holder to release it.

The command looks like this: SET mylock:resource <unique_id> NX EX 30

Acquiring a Lock: Code Example

Here's a simplified example of how a client might attempt to acquire a lock using Python. The SET command returns True (or 'OK') if the lock was acquired, and False (or None) otherwise.

import redis
import uuid

# Connect to Redis
r = redis.Redis(decode_responses=True)

lock_key = "resource:123:lock"
client_id = str(uuid.uuid4())
lock_timeout_seconds = 10

print(f"Client {client_id} attempting to acquire lock...")

# Attempt to acquire the lock
# set(name, value, nx=True, ex=timeout) maps to SET key value NX EX timeout
lock_acquired = r.set(lock_key, client_id, nx=True, ex=lock_timeout_seconds)

if lock_acquired:
  print(f"Client {client_id} acquired the lock!")
  # Simulate work
  # time.sleep(5)
  # ... do critical section work ...
  # r.delete(lock_key) # DON'T do this directly!
else:
  print(f"Client {client_id} failed to acquire the lock. It's held by someone else.")

# In a real app, you'd release the lock safely later.

The Challenge of Releasing a Lock Safely

Simply deleting the lock key (e.g., DEL mylock:resource) is NOT safe. Consider this scenario:

Client A acquires the lock with an expiration of 10 seconds.
Client A's operation takes longer than 10 seconds, so the lock expires automatically.
Client B acquires the lock for the same resource.
Client A's operation finally finishes and attempts to delete the lock. It unknowingly deletes Client B's lock!

This leads to two clients thinking they have the lock simultaneously, defeating its purpose. We need an atomic way to check ownership AND delete.

Atomic Release with Lua Scripts

Redis allows executing Lua scripts atomically. This means the entire script runs as a single, uninterruptible operation on the Redis server, solving our lock release problem.

The Lua script for releasing a lock typically does two things:

It checks if the current lock value matches the unique ID provided by the client attempting to release the lock.
If they match, it deletes the lock key.

This guarantees that only the client who originally acquired the lock (and whose unique ID is still stored) can release it, even if the lock has expired and been re-acquired by another client.

Releasing a Lock: Code Example

Here's how you'd execute a Lua script to safely release a lock. The script ensures that you only delete the lock if you are its rightful owner.

import redis
import uuid

r = redis.Redis(decode_responses=True)

lock_key = "resource:123:lock"
client_id = str(uuid.uuid4())
lock_timeout_seconds = 10

# Assume client_id has previously acquired the lock
# For demonstration, let's manually set it:
r.set(lock_key, client_id, nx=True, ex=lock_timeout_seconds)
print(f"Client {client_id} acquired the lock for demo.")

lua_script = """
  if redis.call('GET', KEYS[1]) == ARGV[1] then
    return redis.call('DEL', KEYS[1])
  else
    return 0
  end
"""

# Execute the Lua script
# KEYS[1] is lock_key, ARGV[1] is client_id
released = r.eval(lua_script, 1, lock_key, client_id)

if released:
  print(f"Client {client_id} successfully released the lock.")
else:
  print(f"Client {client_id} failed to release the lock (not owner or already expired).")

# Check if the key still exists
if r.exists(lock_key):
  print(f"Lock key '{lock_key}' still exists.")
else:
  print(f"Lock key '{lock_key}' does not exist.")

Lock Expiration & Renewal

The EX (expiration) option is vital. It acts as a safety net, ensuring locks are eventually released even if the client crashes or fails to release it. Without expiration, a crashed client could hold a lock indefinitely, causing a permanent deadlock.

Too short: If the expiration is too short, long-running tasks might lose their lock prematurely.
Too long: If it's too long, deadlocks might persist for an unacceptable duration.

For tasks that might exceed the initial expiration, clients can implement a 'lock renewal' mechanism. This involves periodically checking if they still hold the lock and, if so, extending its expiration time using EXPIRE or PEXPIRE commands.

Redlock: For Higher Guarantees

While a single Redis instance with SET NX EX works for many cases, it has a single point of failure. If that Redis instance goes down, all locks are lost or become unavailable.

The Redlock algorithm addresses this by requiring clients to acquire locks on a majority of independent Redis master instances (e.g., 3 out of 5). This provides higher guarantees:

Fault tolerance: If one Redis instance fails, the system can still function.
Stronger safety: Reduces the chance of multiple clients acquiring the same lock.

Redlock is more complex to implement but offers a robust solution for critical distributed systems.

Quick Check: Lock Properties

Which of the following are essential properties for a reliable distributed lock using Redis, assuming a single Redis instance?

Recap: Distributed Locks with Redis

In this lesson, we explored how to implement reliable distributed locks using Redis.

We learned that SET key value NX EX seconds is the foundation for acquiring a lock atomically.
A unique value identifies the lock holder, preventing others from releasing it.
Expiration (EX) is vital for preventing permanent deadlocks if a client crashes.
Safely releasing a lock requires an atomic check-and-delete operation, typically achieved with Lua scripting.
For higher reliability and fault tolerance in multi-instance setups, the Redlock algorithm can be employed.

Understanding these principles is key to building robust and concurrent distributed applications.

Frequently asked questions

Is the “Distributed Locks with Redis” lesson free?

Yes — the full text of “Distributed Locks with Redis” is free to read here on the web, and the Redis Caching & Messaging (Pub/Sub, Streams) course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Redis Caching & Messaging (Pub/Sub, Streams) course, upgrade to CoddyKit PRO.

What will I learn in “Distributed Locks with Redis”?

Implement reliable distributed locking mechanisms using Redis to coordinate access in concurrent systems. You practise Redis Caching & Messaging (Pub/Sub, Streams) with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start Redis Caching & Messaging (Pub/Sub, Streams)?

No prior experience is required. Redis Caching & Messaging (Pub/Sub, Streams) on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Distributed Locks with Redis” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this Redis Caching & Messaging (Pub/Sub, Streams) lesson?

Yes. Every Redis Caching & Messaging (Pub/Sub, Streams) lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to Redis Caching & Messaging (Pub/Sub, Streams)