...
# | Title | User Story | Importance | Notes | Status | ||
---|---|---|---|---|---|---|---|
1 | Node emits metrics through the metrics API | Node operators want access to any and all metrics related to node operation and performance. | Must have |
| Metrics emitted on http port 40403. Complete (metrics emitted via API) | ||
2 | Node measures COMM Events | COMM events are a measure of an RChain transaction. The node must report on how many raw comm events are being processed, so we can demonstrate 40K COMM events /second | Must Have |
| Rita Allen to validate the requirement, see what has been implemented. | ||
3 | Node reports on CPU Utilization | The Node reports on the percentage of CPU that is being consumed. | Must Have |
| Rita Allen Please confirm the status | ||
4 | Node reports on total RAM consumed | The node reports on the amount of RAM being consumed | Must Have |
| Rita Allen Please confirm the status | ||
5 | Deploy Count | The node reports on the total number of deployments received | Must Have |
| Needs to be implemented. Should have a ticket. Add ticket number here Rita Allen | 6RHOL-924 | |
6 | Deploys since last propose | The node reports the total number of deploys received since the last propose | Nice to have | Report on the total number of deploys received via the deploy API since the last successful propose | RHOL-913 | ||
7 | Blocks proposed | A validating node proposes blocks | Must Have |
| Needs to be implemented. Should have a ticket. Add ticket number here Rita Allen. | 7CORE-1298 | |
8 | Fork Choice Tip | For something like Ethstats.net, it would be good to show the current fork choice tip for each node | Nice to have |
| |||
89 | Blocks being processed? | 9 | Time since last block?CORE-1300 | ||||
10 | Demonstration of a node operating monitoring system | Node operators will have various needs and expectations for their node monitoring system. The RChain node will not dictate the system they use. However, at launch of test net there will be an example of a node operating system to share as an example, along with documentation in the event a node operator wants to reproduce the example monitoring system. | Must have |
| |||
11 | Documentation on how to export metrics using Prometheus | Node operators need to know how to access the Prometheus integration in the node. | Must have | ||||
12 | Documentation on how to export metrics from metrics API using Scala | Node operators need to know how to interface with the metrics API. Developers need to know how to interface with the metrics API when integrating features with the node. | Must have |
| In progress. First draft at RChain RNode Metrics - Node Operator | ||
13 | Metrics acceptability testing | Validate exposure and pull of metrics works using both Prometheus and the metrics API | Must have |
| |||
14 | Integration with Docker compose | Some node operators may want the option to monitor the node using Docker compose | Optional |
| Done |
...