Cleanup monitoring docs #236
Merged
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
Contributor
haroldsphinx
commented
Jul 25, 2023
haroldsphinx
commented
- cleanuo contents
Signed-off-by: haroldsphinx <adedayoakinpelu@gmail.com>
Signed-off-by: haroldsphinx <adedayoakinpelu@gmail.com>
Signed-off-by: haroldsphinx <adedayoakinpelu@gmail.com>
✅ Deploy Preview for obol-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
maeliosakyne
requested changes
Jul 25, 2023
docs/int/quickstart/monitoring.md
Outdated
| ## Understanding Alert rules | ||
|
|
||
| 1. `AlphaClusterBeaconNodeDown`This alert is activated when the beacon node in a specified Alpha cluster is offline. The beacon node is crucial for validating transactions and producing new blocks. Its unavailability could disrupt the overall functionality of the cluster. | ||
| 2. `AlphaClusterBeaconNodeSyncing`This alert indicates that the beacon node in a specified Alpha cluster is synchronizing, i.e., catching up with the latest blocks in the cluster. |
There was a problem hiding this comment.
Can a semicolon with a space before 'the' be added to each of these lines, I can see this is included in some lines further down but not all, so we should try and keep this consistent
docs/int/quickstart/monitoring.md
Outdated
| 1. `AlphaClusterBeaconNodeDown`This alert is activated when the beacon node in a specified Alpha cluster is offline. The beacon node is crucial for validating transactions and producing new blocks. Its unavailability could disrupt the overall functionality of the cluster. | ||
| 2. `AlphaClusterBeaconNodeSyncing`This alert indicates that the beacon node in a specified Alpha cluster is synchronizing, i.e., catching up with the latest blocks in the cluster. | ||
| 3. `AlphaClusterNodeDown`This alert is activated when a node in a specified Alpha cluster is offline. | ||
| 4. `AlphaClusterMissedAttestations`:This alert indicates that there have been missed attestations in a specified Alpha cluster. Missed attestations may suggest that validators are not operating correctly, compromising the security and efficiency of the cluster. |
There was a problem hiding this comment.
Add a space after the semicolons, before 'The'
docs/int/quickstart/monitoring.md
Outdated
| 8. `AlphaClusterVCMissingValidators`: This alert is activated if any validators in the Alpha M1 Cluster #1 are missing. | ||
| 9. `AlphaClusterHighPctFailedSyncMsgDuty`: This alert is activated if a high percentage of sync message duties failed in the "Alpha M1 Cluster #1". The alert is activated if the sum of the increase in failed duties tagged with "sync_message" in the last hour divided by the sum of the increase in total duties tagged with "sync_message" in the last hour is greater than 0.1. | ||
| 10. `AlphaClusterNumConnectedRelays`: This alert is activated if the number of connected relays in the "Alpha M1 Cluster #1" falls to 0. | ||
| 11. PeerPingLatency: 1. This alert is activated if the 90th percentile of the ping latency to the peers in a cluster exceeds 500ms within 2 minutes. |
There was a problem hiding this comment.
Should there be quotation marks around PeerPingLatency?
|
Hey @haroldsphinx, could you add the recommendations shared over Slack as well? Thanks |
added 5 commits
August 16, 2023 17:28
maeliosakyne
approved these changes
Aug 17, 2023
thomasheremans
approved these changes
Aug 17, 2023
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.