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

Docs: Document different hashing algorithms in receivers #5681

Open
matej-g opened this issue Sep 9, 2022 · 10 comments
Open

Docs: Document different hashing algorithms in receivers #5681

matej-g opened this issue Sep 9, 2022 · 10 comments

Comments

@matej-g
Copy link
Collaborator

matej-g commented Sep 9, 2022

Is your proposal related to a problem?

We recently introduced new hashing algorithm, and although it feels "semi-experimental" to me at this stage, I think it would be good to document both the existing default algorithm and the new algorithm.

Describe the solution you'd like

As a user, when considering Thanos receiver, I want to be able to tell from the docs:

  • How Hashmod algorithm and Ketama algorithm work, what are their pros and cons, what are their performance implications, how do they compare when horizontally scaling etc.
  • How and whether I can migrate from one algorithm to another easily, what is the exact procedure, what are the pitfalls

Additional context

The original proposal for Thanos receiver details some working of the Hashmod algorithm: https://thanos.io/tip/proposals-done/201812-thanos-remote-receive.md/
For Ketama, the recent PR is useful for understanding: #5408

@rahul3002
Copy link

i would like too work on this issue

@matej-g
Copy link
Collaborator Author

matej-g commented Sep 19, 2022

Go for it @rahul3002 💪

@rahul3002
Copy link

I have created introduction for hashing algorithm, but I'm bit confused on which file should i add that information, can u give the link of that particular file or location of that file

@matej-g
Copy link
Collaborator Author

matej-g commented Sep 26, 2022

I believe new section in https://thanos.io/tip/components/receive.md/ would be the most appropriate. What do you think?

@rahul3002
Copy link

will do it once then will decide

@rahul3002
Copy link

should i upload it here

@matej-g
Copy link
Collaborator Author

matej-g commented Oct 4, 2022

@rahul3002 What do you mean? Could you open a PR and we can review it? 🙂

@rahul3002
Copy link

if u can share me the exact location of the file where I can update algorithm will be really helpful

@sayantandasgupta
Copy link

Hi, I would like to work on this issue. Can anyone guide me to a starting point?

@hackeramitkumar
Copy link
Contributor

@matej-g I would like to work on it. Can you please assign it to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants