Skip to content

Commit

Permalink
Update Validator_Monitoring_Service_2_keeganquigley.md
Browse files Browse the repository at this point in the history
  • Loading branch information
keeganquigley authored Apr 9, 2024
1 parent 7ed458f commit 16fbe2f
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions evaluations/Validator_Monitoring_Service_2_keeganquigley.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Evaluation

- **Status:** In progress
- **Status:** Accepted
- **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/Validator_Monitoring_Service.md
- **Milestone:** 2
- **Evaluation by:** keeganquigley_

**Deliverables**

Expand All @@ -11,16 +12,16 @@
| 0a. | License | <ul><li>[x] </li></ul> | Apache 2.0 | | |
| 0b. | Documentation | <ul><li>[x] </li></ul> | We will provide a tutorial page that explains how a user can set up monitoring for selected validators. We show how our functionality works and give reasoning and explanations for all metrics that are shown to the user. | | |
| 0c. | Testing Guide | <ul><li>[ ] </li></ul> | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | https://github.com/p2p-org/polkadot_monitoring_service | |
| 0d. | Docker | <ul><li>[x] </li></ul> | We will provide a Dockerfile(s) that can be used to self-host the telegram bot and check the functionality. | | |
| 0e. | Article | <ul><li>[x] </li></ul> | We will publish an article that explains the user flow of our system and promotes using monitoring for validators operators. | https://p2p.org/economy/validator-monitoring-service-user-guide/ | A user guide that covers all functionality of the Grafana dashboard and telegram bot |
| 1. | Telegram bot adding alerting based on events | <ul><li>[x] </li></ul> | We will introduce a feature that allows users to subscribe to specific events. This means users can opt to receive Telegram notifications when their chosen validators receive rewards, are elected into the active set, and more. | Tg bot is made for self-hosted version (just follow the steps in repo and create your own tg bot) or by using our bot: @p2pvalidator_monitoring_bot | The alerting subscription is added to the tg bot, and the alerting system is fully functional based on on-chain events exporters for all networks. |
| 2. | Improve UX Dashboard | <ul><li>[x] </li></ul> | We plan to streamline Grafana's interface by removing surplus controls, enhancing the quality of our charts, and implementing Kiosk mode. We aim to bolster security through provisioning measures, such as enforcing password changes for users. | Grafana is available either in self-hosted version (locally) or by using our bot @@p2pvalidator_monitoring_bot | The UX is improved; for a user, it’s possible to track all validators simultaneously (just with a simple filter) and well as a separate dashboard for major parachains for added. |
| 3. | Cover monitoring for parachains | <ul><li>[x] </li></ul> | We will add the support of the most popular parachains such as Moonbeam, Moonriver, Acala, Karura, Astar, Shiden | Also available by self-hosted version or in our bot @p2pvalidator_monitoring_bot | Grafana dashboard, monitoring, and alerting system is available for both relay chains, Polkadot and Kusama, as well as for major parachains such as Moonbeam, Moonriver, Acala, and Karura. |
| 4. | Auto-remove instances | <ul><li>[x] </li></ul> | We will develop a system that identifies and removes inactive Grafana instances. | Single instance solution made | Done; the system is automated and does not create a separate Grafana instance for each user. It simplifies the deployment and management of back-end infrastructure |
| 0d. | Docker | <ul><li>[x] </li></ul> | We will provide a Dockerfile(s) that can be used to self-host the telegram bot and check the functionality. | | Works. |
| 0e. | Article | <ul><li>[x] </li></ul> | We will publish an article that explains the user flow of our system and promotes using monitoring for validators operators. | https://p2p.org/economy/validator-monitoring-service-user-guide/ | Looks good. |
| 1. | Telegram bot adding alerting based on events | <ul><li>[x] </li></ul> | Bot works as expected. |
| 2. | Improve UX Dashboard | <ul><li>[x] </li></ul> | We plan to streamline Grafana's interface by removing surplus controls, enhancing the quality of our charts, and implementing Kiosk mode. We aim to bolster security through provisioning measures, such as enforcing password changes for users. | Grafana is available either in self-hosted version (locally) or by using our bot @@p2pvalidator_monitoring_bot | UI looks great. |
| 3. | Cover monitoring for parachains | <ul><li>[x] </li></ul> | We will add the support of the most popular parachains such as Moonbeam, Moonriver, Acala, Karura, Astar, Shiden | Also available by self-hosted version or in our bot @p2pvalidator_monitoring_bot | Works for said parachains. |
| 4. | Auto-remove instances | <ul><li>[x] </li></ul> | We will develop a system that identifies and removes inactive Grafana instances. | Single instance solution made | Good. |

# General Notes

Nice work! I'm able to run the bot locally and on production version. Grafana dashboards working and look nice. I can subscribe and unsubscribe the the bot successfully.
Nice work! I'm able to run the bot locally and on production version. Grafana dashboards working and look nice. I can subscribe and unsubscribe the the bot successfully. This should prove to be a useful tool for validators.

![grafana](https://github.com/w3f/Grant-Milestone-Delivery/assets/35080151/350c4732-f688-46b2-ad12-5b4deddaebac)

Expand Down

0 comments on commit 16fbe2f

Please sign in to comment.