redis-doc icon indicating copy to clipboard operation
redis-doc copied to clipboard

update sentinel commands doc

Open hwware opened this issue 5 years ago • 11 comments

there are some sentinel command missing in the sentinel doc. this PR adds these commands.

hwware avatar Oct 13 '20 14:10 hwware

Hello @oranagra , the command of sentinel info-cache basicallly returning the cached info for all the specified masters their slaves, and if no master name provided, it simply returning all cached master and its slave info and its time for how long it was received.that's why it is ok to have 0, 1 or more additional arguments. I think we need to mention this in a better way to avoid people get confused. I will do a fix shortly. Also I think you bring a good topic here, I also feel there are lots of documentation missing good explation for Sentinel part. Most of the sentinel code was written around 6 years ago (including the info-cache one) so there are missing lots of things. I would suggest we put the sentinel command also into the commands page (https://redis.io/commands). But that requires a lot of documentation change and not sure whether we worth to do it. How do you think?

hwware avatar Oct 15 '20 00:10 hwware

I rather not mix Sentinel commands with Redis commands in the same table / index. We can maybe create a similar section lile redis.io/sentinal/commands/ which will behave the same (using the same infrastructure). but i'm not sure it worth the effort. @itamarhaber any opinion on that?

For now, let's just try to improve the existing page. But i just wonder if some of these commands were not documented on purpose. If one of these commands exist from day one (before the documentation page was created), then it must mean that someone considered that an internal debug command and didn't bother to document it. much like the Redis REPLCONF and (most of) DEBUG commands aren't mentioned.

oranagra avatar Oct 15 '20 05:10 oranagra

@oranagra I see, and that is a very good point.. I checked this when at the very beginning Salvatore's commit https://github.com/redis/redis-doc/commit/78c6f7ec0182f4c67d31243a6f80f5594d9224cf#diff-4578785ae9106bc325486759f3f1eae0de1bf7c18af224a19d7c3146cc10b872R161 he mentioned the is-master-down-by-addr command in the doc, but later he removed it. Maybe the is-master-down-by-addr api is used for debugging purpose and Salvatore deliberatey removed it in the doc.

hwware avatar Oct 19 '20 04:10 hwware

looks like at some point Salvatore added a new sentinel doc that didn't include is-master-down-by-addr in the list of commands, and much later he removed the old doc that did have it. 173155f6d3b185348fb62c8dceb5616a33d51ffa 03c4ad501966606c0b1883486a876c15102279ae however, even the new doc does refer to is-master-down-by-addr (it is mentioned a few times, just not listed), so i think we can add it back.

i see that: pending-scripts exists since 2012 (3f194a9d2571df21717b635f037040407a51d50d) info-cache exists since 2014 (f8c73e38b5f5a57d6d573fc6fdfed5b68d4879c8) simulate-failure exists since 2015 (fb3af75f7478c6d0717d076289976f16b2389e28) so it seems to me that the later two (being more recent addition) might have just been overlooked. but i'd guess that the first one isn't listed on purpose.

@itamarhaber maybe you can think of some old-timer that can shed more light on this?

oranagra avatar Oct 19 '20 07:10 oranagra

Regrettably, I can't think of someone like that.

itamarhaber avatar Feb 02 '21 10:02 itamarhaber

ok. so let's do what we think is right. @hwware wanna refresh this PR and decide which of the unlisted commands should be listed and which ones can be skipped?

oranagra avatar Feb 02 '21 12:02 oranagra

@hwware do you want to give this a final push? I promise to merge 🤞

itamarhaber avatar May 31 '22 10:05 itamarhaber

@itamarhaber give me some time to refresh my memory and push it, Thanks

hwware avatar May 31 '22 16:05 hwware

Deploy request for redis-doc pending review.

Visit the deploys page to approve it

Name Link
Latest commit d3fd1cf21b0a12f81ac162abadcfb1beecb8eddc

netlify[bot] avatar May 31 '22 18:05 netlify[bot]

@itamarhaber Updated, please take a look, Thanks

hwware avatar May 31 '22 18:05 hwware

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Mar 21 '24 17:03 CLAassistant