Grafana Metric

[jennijuju]

Need

• lotus and lotus miner should ship with default Grafana monitoring to help our users monitoring their systems the collected metrics could also be a useful data to ask when they report bug and so.
• we also need user docs to show user how to config and set up their board.

One of the task of ground control is to set up Grafana board for the system - lets use this opportunity to build up the monitoring board piece by piece, and test on ground control system

@rjan90 has kindly listed the existing pieces below:

• Fridrik has shipped documentation in the Lotus-repo on how you setup monitoring (grafana+prometheus) for a local Lotus node here.
• We should port this guide to the Lotus docs.
  And also create a similar docs that covers how to setup monitoring for the Lotus-Miner w/Sealing dashboard.
• The “Ship LM Graphana dashboard by default” issue ticket has a sealing dashboard JSON template from Magik that can be added as the default dashboard, but also further expanded on.
• Next steps would be to go on the SPWG calls and get feedback on what they want in the monitoring dashboard. I think one starting point based on feedback from Nathaniel is supporting “Multiple miners under the same prom job”

I think filecoin-project/lotus#10891 & orphan block are also good info to collect.

[Reiers]

Monitoring Plan for Lotus and Lotus Miner

Need:

lotus and lotus-miner should come equipped with default Grafana monitoring. This will assist our users in monitoring their systems. Additionally, the metrics collected can be invaluable when users report bugs. We also require user documentation to guide users on configuring and setting up their board.

As part of Needler's tasks, there's a need to set up a Grafana board for the system.
Construct the monitoring board incrementally and test it on the Needler system.

Existing Resources:

• Fridrik has provided documentation in the Lotus-repo detailing how to set up monitoring (Grafana + Prometheus) for a local Lotus node. Link to the documentation.

Action: Port this guide to the Lotus docs.

Action: Develop a similar guide that covers the setup process for the lotus-miner with the Sealing dashboard.

The issue ticket titled “Ship LM Graphana dashboard by default” contains a sealing dashboard JSON template from Magik. This can serve as the default dashboard and can be expanded further.

Next Steps:

• Attend the SPWG calls and gather feedback on desired features for the monitoring dashboard.
• Initial feedback from Nathaniel suggests support for “Multiple miners under the same prom job”.

Consider integrating metrics from filecoin-project/lotus#10891 & orphan block as they could provide valuable insights.

Assignment

Task: Develop a concrete plan for the monitoring work.

Details:

Determine the metrics for the MVP.
Begin the implementation of these metrics.
Deadline: End of September (EoSep)

Deliverables:

• Ship basic metrics in the Lotus master.
• Propose the initial scope and gather team feedback.
• Create user documentation on setting up the monitoring. Aim for a setup time of 5 minutes for @TippyFlitsUK .

Future Planning:

Plan metrics for Q4.
Aim to feature this in the November release.