Merge pull request #28 from waku-org/chore/node-healthy-clarity

chore: clarifications for node health when disparity in protocol health
This commit is contained in:
Danish Arora 2024-07-24 15:09:09 +05:30 committed by GitHub
commit 6ff4b057ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -40,13 +40,14 @@ Node health is a metric meant to determine the connectivity state of a light nod
We consider this reliability to be dependent on amount of simultaneous connections to responsive service nodes. We consider this reliability to be dependent on amount of simultaneous connections to responsive service nodes.
Unfortunately the more connections light node establishes - the more bandwidth is consumed. Unfortunately the more connections light node establishes - the more bandwidth is consumed.
To address this we RECOMMEND following states: To address this we RECOMMEND following states:
- unhealthy - no connections to service nodes are available regardless of protocol; - unhealthy:
- no connections to service nodes are available regardless of protocol;
- minimally healthy: - minimally healthy:
- Filter has one service node connection; - Filter has one service node connection AND LightPush protocol has one service node connection;
- LightPush protocol has one service node connection;
- sufficiently healthy: - sufficiently healthy:
- Filter has at least 2 connections available to service nodes; - Filter has at least 2 connections available to service nodes AND LightPush has at least 2 connections available to service nodes;
- LightPush has at least 2 connections available to service nodes;
Overall node health SHOULD be considered as unhealthy or minimally healthy respectively if one of the protocols is unhealthy or minimally healthy, while the other is sufficiently healthy.
### Peers and connection management ### Peers and connection management