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

A redis based lock for distributed tusd instances #1129

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

whytheplatypus
Copy link

This introduces a redis backed locker. This is probably most useful for tusd instances that are distributed, ephemeral, or have to scale up and down.

It uses the redis pub/sub feature to request a lock be released.

The tests use what looks like a pretty nice little redis implementation meant for testing.

@Acconut
Copy link
Member

Acconut commented May 8, 2024

Thank you very much for this PR! I will have a more thorough look next week. There are a few things I would like to add to this PR are: documentation for the package itself, documentation for our homepage (https://tus.github.io/tusd), integration with the CLI (so that it can also be used with the tusd binary), and maybe more in-depth tests to ensure that the release notifications also work properly. But I can take care of those :)

@thedentist8
Copy link

Awesome, would be great if this gets merged.

@whytheplatypus, I'm wondering if you've had a chance to run this on production and how it looks so far?

@pcfreak30
Copy link

Just thought I would point this out as you implemented your own locking design.

https://github.com/go-redsync/redsync is available and I likely will be switching to https://github.com/redis/rueidis soon and https://github.com/redis/rueidis/blob/main/rueidislock/lock.go is a route.

@whytheplatypus

@Acconut
Copy link
Member

Acconut commented Jul 31, 2024

@pcfreak30 I am not sure what you mean here. This PR is using the redsync package already instead of implementing its own locking approach. Do you want to imply that using the lock from rueidis is preferable over redsync?

@pcfreak30
Copy link

@pcfreak30 I am not sure what you mean here. This PR is using the redsync package already instead of implementing its own locking approach. Do you want to imply that using the lock from rueidis is preferable over redsync?

woops i did not see that. I saw some of the pub/sub code and was thinking the locking system was re-implemented vs using a established library.

Other that that I would look at rueidis because I myself am probably going to have to move all my redis stuff to it, even if i stay using redsync as a library, because im getting a lot of connection pool timeouts and from reading, i think rueidis will handle things better and performs better overall based on their readme vs go-redis.

@whytheplatypus
Copy link
Author

Awesome, would be great if this gets merged.

@whytheplatypus, I'm wondering if you've had a chance to run this on production and how it looks so far?

we have! so far it's looking solid. We've been able to scale horizontally cleanly and seen an increase in stability, though I don't have before and after numbers for you.

We did have to make one change in the lock exchange behavior, using short lived a pub sub channel per lock rather than using only one long lived one. This was because that one channel was getting full, while the short lived channels don't and also seem to perform better. It probably could have been done by adjusting some redis config but the change also simplified the code and so far has been working well at scale. I'll try and get that change in this PR in the next couple days.

@whytheplatypus
Copy link
Author

@pcfreak30 I am not sure what you mean here. This PR is using the redsync package already instead of implementing its own locking approach. Do you want to imply that using the lock from rueidis is preferable over redsync?

woops i did not see that. I saw some of the pub/sub code and was thinking the locking system was re-implemented vs using a established library.

Other that that I would look at rueidis because I myself am probably going to have to move all my redis stuff to it, even if i stay using redsync as a library, because im getting a lot of connection pool timeouts and from reading, i think rueidis will handle things better and performs better overall based on their readme vs go-redis.

maybe we can look at getting an interface in front of the needed interactions with redis, so that swapping libraries is an option.

@pcfreak30
Copy link

@whytheplatypus im about to switch to this in a fork of tusd (I am also sticking to the default v9 redis client for now), and one thing i noticed is the assumption to create a new redis instance. I will need to be able to pass an existing in as well. While ill modify that in my fork, would appreciate you adding it.

@Acconut Acconut changed the title A redis based lock for distribued tusd instances A redis based lock for distributed tusd instances Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants