ObolNetwork / ObolNetwork/obol-docs
Provide Required Information for Alpha Cluster Monitoring Documentation
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 27
- Forks
- 61
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 2
Description
🎯 Problem to be solved:
The current documentation for setting up monitoring for the Alpha Cluster lacks specific details needed to guide our users effectively. The missing information includes correct flags for the Charon cluster, the Charon cluster node, the relay node, methods to check block authorship, troubleshoot block authorship, and check good peer connectivity.
🛠️ Proposed solution:
The team should review the current documentation and add details regarding:
- Correct flags for the Charon cluster
- Correct flags for the Charon cluster node
- Correct flags for the relay node
- Methodology to check block authorship
- Troubleshooting guide for block authorship (including how to check if a block misses duty)
- Procedure to check good peer connectivity
With these additions, we can ensure our users have a comprehensive guide to setting up monitoring for the Alpha Cluster.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the current Alpha Cluster monitoring documentation and identify where Charon cluster, cluster-node, and relay-node setup is described. Add the requested flag details and procedures for checking and troubleshooting block authorship, including missed duties, plus checking peer connectivity; the documentation is done when these monitoring tasks are covered for users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100