Difference between revisions of "Node Provider Maintenance Guide"

From Internet Computer Wiki
Jump to: navigation, search
m (Added some text for the regular maintenance)
m
Line 1: Line 1:
 +
= Joining the Node Provider Matrix Channel =
  
 +
== Introduction ==
  
Join the [[Node Provider Matrix channel]]. Here, you can submit questions or comments related to Node Provider node maintenance. Please make sure to have working notifications for new messages, since your assistance may be required at a short notice in exceptional cases.
+
Node Providers are encouraged to join the dedicated [[Node Provider Matrix channel]]. This platform is essential for discussing maintenance-related queries and sharing insights about node operations.
  
During regular operations, you are expected to keep track of the node health. Node health is shown on the public dashboard. Example: https://dashboard.internetcomputer.org/node/b5d56-nm7ae-p24jg-t25gp-5bmhb-rjbnt-3dmoq-goqby-5tf6c-ygnnu-aqe
+
= Communication Guidelines =
[[File:Node-status-dashboard.png|center|thumb|729x729px|Node status on the public dashboard]]
 
Some node providers shared the fruits of their hard work, and made it easier to get notified if a node becomes unhealthy:
 
  
https://www.aviatelabs.co/node-monitor -- turn key solution, get an email if a node becomes unhealthy
+
* '''Active Participation''': Ensure your notifications are enabled to receive new messages promptly. Your input or intervention might be crucial, especially in urgent situations.
 +
* '''Regular Operations''': Regularly monitor the health of your node. Node health status is available on the public dashboard, which. Example: [https://dashboard.internetcomputer.org/node/b5d56-nm7ae-p24jg-t25gp-5bmhb-rjbnt-3dmoq-goqby-5tf6c-ygnnu-aqe node status].
  
https://github.com/aviate-labs/node-monitor -- run your own node monitor
+
= Tools and Resources =
  
https://github.com/virtualhive/ic-node-status-prometheus-exporter
+
Several node providers have generously shared tools to facilitate monitoring node health. These tools can provide notifications in case of node issues.
[[File:Node-status-prometheus-exporter.png|center|thumb|673x673px|Prometheus exporter for the IC node status (by virtualhive)]]
 
  
 +
== Aviate Labs Node Monitor ==
 +
 +
* '''Turnkey Solution''': Receive email alerts for unhealthy nodes.
 +
* '''Link''': [https://www.aviatelabs.co/node-monitor AviateLabs Node Monitor]
 +
 +
== DIY Node Monitoring ==
 +
 +
* '''GitHub Repository''': Run your own node monitoring system.
 +
* '''Link''': [https://github.com/aviate-labs/node-monitor Aviate Labs GitHub]
 +
 +
== Prometheus Exporter for Node Status ==
 +
 +
* '''GitHub Repository''': A tool for exporting node status to a Prometheus-compatible format.
 +
* '''Link''': [https://github.com/virtualhive/ic-node-status-prometheus-exporter IC Node Status Prometheus Exporter]
 +
 +
= Additional Notes =
 +
 +
* '''Screenshots''': Include screenshots of the node status from the public dashboard for reference and troubleshooting.
  
 
In case you observe issues, follow: [[Unhealthy Nodes]] and [[Node Provider Troubleshooting]]
 
In case you observe issues, follow: [[Unhealthy Nodes]] and [[Node Provider Troubleshooting]]

Revision as of 12:20, 13 November 2023

Joining the Node Provider Matrix Channel

Introduction

Node Providers are encouraged to join the dedicated Node Provider Matrix channel. This platform is essential for discussing maintenance-related queries and sharing insights about node operations.

Communication Guidelines

  • Active Participation: Ensure your notifications are enabled to receive new messages promptly. Your input or intervention might be crucial, especially in urgent situations.
  • Regular Operations: Regularly monitor the health of your node. Node health status is available on the public dashboard, which. Example: node status.

Tools and Resources

Several node providers have generously shared tools to facilitate monitoring node health. These tools can provide notifications in case of node issues.

Aviate Labs Node Monitor

DIY Node Monitoring

Prometheus Exporter for Node Status

Additional Notes

  • Screenshots: Include screenshots of the node status from the public dashboard for reference and troubleshooting.

In case you observe issues, follow: Unhealthy Nodes and Node Provider Troubleshooting