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

Allow setting ring heartbeat timeout to zero to disable timeout check. #4342

Merged
merged 2 commits into from
Jul 9, 2021

Conversation

stevesg
Copy link
Contributor

@stevesg stevesg commented Jul 6, 2021

What this PR does:
This change allows the various ring heartbeat timeouts to be configured
with zero, as a means of disabling the timeout. This is expected to be
used with a separate enhancement to allow disabling heartbeats. When the
heartbeat timeout is disabled, instances will always appear as healthy
in the ring.

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

@stevesg stevesg force-pushed the ring-timeout-disable branch from 566df03 to 16a505e Compare July 6, 2021 14:09
This change allows the various ring heartbeat timeouts to be configured
with zero, as a means of disabling the timeout. This is expected to be
used with a separate enhancement to allow disabling heartbeats. When the
heartbeat timeout is disabled, instances will always appear as healthy
in the ring.

Signed-off-by: Steve Simpson <[email protected]>
@stevesg stevesg force-pushed the ring-timeout-disable branch from 16a505e to e0bd75e Compare July 6, 2021 14:10
CHANGELOG.md Show resolved Hide resolved
pkg/ring/ring_test.go Outdated Show resolved Hide resolved
Copy link
Contributor

@pracucci pracucci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change LGTM. I guess we'll need a follow up PR to also allow disabling heartbeating the ring at all (this PR just checks the timeout). What your plans on this?

About this PR: I would mention it as an experimental feature in docs/configuration/v1-guarantees.md

CHANGELOG.md Show resolved Hide resolved
@stevesg
Copy link
Contributor Author

stevesg commented Jul 7, 2021

The two changes together were very confusing as they spread to so many bits of code in subtly different ways, so the disabling is here: #4344

Signed-off-by: Steve Simpson <[email protected]>
@stevesg stevesg marked this pull request as ready for review July 7, 2021 09:53
Copy link
Contributor

@pracucci pracucci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@bboreham bboreham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm - I don't think the word "experimental" is necessary but not going to argue.

@pracucci pracucci merged commit ed62246 into cortexproject:master Jul 9, 2021
alvinlin123 pushed a commit to ac1214/cortex that referenced this pull request Jan 14, 2022
cortexproject#4342)

* Allow setting ring heartbeat timeout to zero to disable timeout check.

This change allows the various ring heartbeat timeouts to be configured
with zero, as a means of disabling the timeout. This is expected to be
used with a separate enhancement to allow disabling heartbeats. When the
heartbeat timeout is disabled, instances will always appear as healthy
in the ring.

Signed-off-by: Steve Simpson <[email protected]>

* Review comments.

Signed-off-by: Steve Simpson <[email protected]>
Signed-off-by: Alvin Lin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants