Skip to content

Latest commit

 

History

History
148 lines (107 loc) · 3.69 KB

README.md

File metadata and controls

148 lines (107 loc) · 3.69 KB
Raw

Redis Record

This lets you record redis streams and commands so that you can replay them easily at a later time.

Under the hood, it uses mcap or zip files as a storage format.

Getting Started - Using Python

To install the redis-record package:

pip install redis_record

Iterating over a recording

from redis_record.storage import get_player

# open your recording
recording_dir = 'my-recordings'
name = 'my-favorite-recording'
with get_player(name, recording_dir) as player:
    # you can read messages like this
    stream_id, timestamp, data_bytes = player.next_message()

    # or just iterate over them like this
    for stream_id, timestamp, data_bytes in player:
        ...

Configuring your environment

By default, we assume that redis is accessible via localhost:6379, but if that's not the case you can change that quite easily.

export REDIS_HOST=localhost
export REDIS_PORT=6379

Each command can also accept --host localhost --port 6379 arguments as well.

Record

To start an on-demand recording:

python -m redis_record.record my_recording

To stop, just Interrupt the script (Ctrl-C).

This will create a file at ./recordings/my_recording.mcap.

Replay

To replay the file into the system, do:

python -m redis_record.replay my_recording

What did I record last week?

List recording names.

python -m redis_record list

Get info about a recording.

python -m redis_record info my_recording

Getting Started - Using Docker

The recorder is designed to be a long-running process, meaning that you can deploy it as a docker container and just control it using redis commands.

This is useful if you want to be able to control the recording remotely and always have the data save to the same place.

git clone https://github.com/beasteers/redis-record.git
cd redis-record

docker-compose up -d
# to observe the recording process
docker logs redis-record

Record

To start a recording, do:

python -m redis_record start my_second_recording

To stop a recording, do:

python -m redis_record stop my_second_recording

Replay

Currently, the replay container isn't a long-running container so you still need to invoke it like above:

python -m redis_record.replay my_recording

Recording more than streams

The previous method is designed to capture XADD commands (data added to Redis streams). If you want to capture other redis commands, we can leverage Redis's MONITOR command to capture all commands.

Record

python redis_record.record.monitor my_other_recording

By default, it will capture any of the SET command variants (xadd, set, hmset, hset, hsetnx, lset, mset, msetnx, psetex, setbit, setrange, setex, setnx, getset, json.set, json.mset), but it's easy enough to change!

python redis_record.record.monitor my_other_recording --record-cmds '[xadd,set]'

I was initially going to just do [xadd,set] but figured trying to cover a more general use case as a default would be better.

Replay

To replay:

python redis_record.replay.monitor my_other_recording

Zip Format

The directory structure is as follows:

recordings/
  my_recording/
    data_stream_1/
      12345678-0_12456789-0.zip
      12456789-0_12567890-0.zip
      ...
    my_other_stream/
      ...

Inside the zipped files have the redis timestamp as the filename and the data is the serialized bytes of the 'd' key in the stream.

TODOs

  • recording expiration (auto-stop a recording after e.g. 1 minute of inactivity)
  • s3 recording file storage
  • alternative exporters - e.g. mp4 - but would need consistent/general format.