Utilizing Redis Streams for Event Logging in PHP

Welcome! In this unit, we will explore how to utilize Redis streams for event logging using PHP. This is an important part of our Redis-based backend system project. By the end of this lesson, you will know how to log events and retrieve them using Redis streams. Remember, you've already learned how to manage user data and handle transactions. Now, we're adding another layer to our system by using streams.

In this unit, we will focus on the following tasks:

1. Adding Entries to a Stream: We will log user activities in a Redis stream.
2. Reading Entries from a Stream: You will see how to read the logged events from the stream.

Let's start by refreshing what we've learned about adding data. This time, we will use streams instead of simple keys. Here's a snippet to show how you can add an entry to a stream and read it back using PHP and the Predis library:

<?php

require 'vendor/autoload.php';

use Predis\Client;

// Connect to Redis
$client = new Client();

// Example usage
$streamName = 'user_activity_stream';

try {
    $client->xadd($streamName, ['event' => 'login', 'username' => 'alice']);
    $client->xadd($streamName, ['event' => 'login', 'username' => 'bob']);
} catch (Exception $e) {
    echo "Could not add entry: ", $e->getMessage(), "\n";
}

try {
    // supplying the count of messages as 0 for the first parameter
    // means that we want to read all messages in the stream
    $entries = $client->xread(0, 0, [$streamName, '0-0']);
    foreach ($entries[$streamName] as $entry) {
        echo "Stream entry: " . json_encode($entry) . "\n";
    }
} catch (Exception $e) {
    echo "Could not read entries: ", $e->getMessage(), "\n";
}

In this code, we read the entries from the user_activity_stream and print each one. The streamName and the count of entries to read help control the stream reading operation.

As a reminder for xread parameters, this is their order and meaning:

• Count of Messages (0): This specifies the maximum number of entries to read. A value of 0 means to read all available entries.
• Block Time (0): This is the time in milliseconds to block if no entries are available. A value of 0 means no blocking.
• Streams and IDs ([$streamName, '0-0']):
  • $streamName: The name of the stream you want to read from.
  • '0-0': The ID from which to start reading. '0-0' means to start from the beginning of the stream.

Do you feel ready to give it a try? Let's jump into the practice section and start working on logging events using Redis streams. Happy coding!