fix: join peer list only after refinery is ready to accept traffic #1309
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VinozzZ
force-pushed
the
yingrong.only_join_peer_list_when_refinery_is_ready
branch
from
8eb881f to
6273eac
Compare
kentquirk
approved these changes
Sep 4, 2024
VinozzZ
deleted the
yingrong.only_join_peer_list_when_refinery_is_ready
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Currently, Refinery announces its presence to peers immediately upon startup. This causes the sharding algorithm to direct other peers to forward traces to the newly added Refinery instance, even though it might not be ready to process them. As a result, any spans forwarded before the Refinery is fully operational are lost. This fix ensures that Refinery only announces itself to peers once it is fully ready to accept and process traffic, preventing any loss of spans during startup.
Alternatives:
I have tried to use the
healthmodule as a signal to indicate when therouteris ready for thepeersmodule. However, due to the way theinjectionlibrary works, therouterstarts after thepeersmodule. As a result, whenpeerschecks in with the health system, theroutermay not have registered itself yet. This can causeIsReadyto return true prematurely, before therouteris included in the health checks.Short description of the changes
Readymethod onPeersPeers.Ready()once all components have started