thanos-io / thanos

Highly available Prometheus setup with long term storage capabilities. A CNCF Incubating project.
https://thanos.io
Apache License 2.0
12.98k stars 2.08k forks source link

Docs: Document different hashing algorithms in receivers #5681

Open matej-g opened 2 years ago

matej-g commented 2 years ago

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:

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

rahul3002 commented 1 year ago

i would like too work on this issue

matej-g commented 1 year ago

Go for it @rahul3002 :muscle:

rahul3002 commented 1 year ago

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 commented 1 year ago

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

rahul3002 commented 1 year ago

will do it once then will decide

rahul3002 commented 1 year ago

should i upload it here

matej-g commented 1 year ago

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

rahul3002 commented 1 year ago

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

sayantandasgupta commented 1 year ago

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

hackeramitkumar commented 1 year ago

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