thanos icon indicating copy to clipboard operation
thanos copied to clipboard

Docs: Document different hashing algorithms in receivers

Open matej-g opened this issue 2 years ago • 2 comments

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: https://github.com/thanos-io/thanos/pull/5408

matej-g avatar Sep 09 '22 09:09 matej-g

i would like too work on this issue

rahul3002 avatar Sep 19 '22 09:09 rahul3002

Go for it @rahul3002 :muscle:

matej-g avatar Sep 19 '22 09:09 matej-g

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

rahul3002 avatar Sep 24 '22 07:09 rahul3002

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

matej-g avatar Sep 26 '22 09:09 matej-g

will do it once then will decide

rahul3002 avatar Sep 27 '22 13:09 rahul3002

should i upload it here

rahul3002 avatar Oct 01 '22 12:10 rahul3002

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

matej-g avatar Oct 04 '22 14:10 matej-g

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

rahul3002 avatar Nov 05 '22 12:11 rahul3002

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

sayantandasgupta avatar Dec 02 '22 14:12 sayantandasgupta

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

hackeramitkumar avatar May 05 '23 17:05 hackeramitkumar