Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement redis-compatible (RDB) snapshotting support #293

Closed
danielealbano opened this issue Mar 24, 2023 · 0 comments · Fixed by #313
Closed

Implement redis-compatible (RDB) snapshotting support #293

danielealbano opened this issue Mar 24, 2023 · 0 comments · Fixed by #313
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@danielealbano
Copy link
Owner

danielealbano commented Mar 24, 2023

To both be able to save and load the Key-Value database when the in-memory backend is used and to be compatible with Redis and be able to import its snapshots, as well as allow Redis to load cachegrands' snapshots, it's necessary to implement a snapshotting mechanism that produces RDB compatible files.

Plenty of well written documentation can be found at https://rdb.fnordig.de/ ( https://rdb.fnordig.de/file_format.html ), although it doesn't include the latest changes from version 8 and 9 it's pretty well organized and it's a good reference.

Additional documentation for the newest versions can be found here
https://github.com/sripathikrishnan/redis-rdb-tools/blob/master/docs/RDB_Version_History.textile
https://github.com/sripathikrishnan/redis-rdb-tools/blob/master/docs/RDB_File_Format.textile

Tools in https://rdb.fnordig.de/ and https://github.com/sripathikrishnan/redis-rdb-tools/ can also be used for further validation of the file format compatibility.

@danielealbano danielealbano added the enhancement New feature or request label Mar 24, 2023
@danielealbano danielealbano added this to the v0.2 milestone Mar 24, 2023
@danielealbano danielealbano self-assigned this Apr 6, 2023
@danielealbano danielealbano linked a pull request Apr 9, 2023 that will close this issue
danielealbano added a commit that referenced this issue Apr 9, 2023
This PR implements the necessary support to generate the RDB snapshots
in the background.

A new fiber has been introduced which takes care of generating a
snapshot, depending on the settings. A new set of parameters have been
introduced, example below with explanation in line.

```
  snapshots:
    # The path where the snapshot file will be stored, if the rotation is enabled, the path will be used as prefix and
    # the timestamp of the start of the snapshot will be appended to the file name.
    path: /var/lib/cachegrand/dump.rdb
    # The interval between the snapshots, the allowed units are s, m, h, if not specified the default is seconds.
    interval: 5m
    # The number of keys that must be changed before a snapshot is taken, 0 means no limit
    min_keys_changed: 1000
    # The amount of data that must be changed before a snapshot is taken, the allowed units are b, k, m, g, if not
    min_data_changed: 100mb
    # Rotation settings, optional, if missing the snapshots rotation will be disabled
    rotation:
      # The max number of snapshots files to keep, minimum 2
      max_files: 10
```

The example is from cachegrand.yaml.skel

The new mechanism takes care of reporting every 3 seconds a status
update.

Closes #293 

Notes:
- Currently the redis commands SAVE and BGSAVE are not implemented, so
it's not possible to trigger a backup on demand (#314)
- The SHUTDOWN command needs to be updated to support SAVE and NOSAVE
(#315)
- The shutdown logic needs to be updated to trigger a dump at the
shutdown unless the SHUTDOWN NOSAVE command has been issued (#316)
- The current implementation also doesn't compress strings with the LZF
algorithm as liblzf is causing segfault and the issue has to be
investigated (#312)
- Tests for the high level snapshotting process (implemented in
storage_db_snapshot.c mostly) are not included in this PR (#317)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant