Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Prometheus metrics and Grafana Dahsboard for signer #1834

Closed
2 tasks done
jpraynaud opened this issue Jul 16, 2024 · 1 comment · Fixed by #1833
Closed
2 tasks done

Document Prometheus metrics and Grafana Dahsboard for signer #1834

jpraynaud opened this issue Jul 16, 2024 · 1 comment · Fixed by #1833
Assignees
Labels
documentation 📖 Documentation to add/update

Comments

@jpraynaud
Copy link
Member

jpraynaud commented Jul 16, 2024

Why

Some SPO asked for explanation about the Prometheus metrics and Grafana dashboard for the Mithril signer node.

What

Add some explanation about the metrics in the signer node in the documentation.

How

@dlachaume
Copy link
Collaborator

dlachaume commented Jul 16, 2024

This is a proposal to expand the description of the Grafana dashboard template page:


We recommend configuring the dashboard to retrieve data over a meaningful period (e.g., 24 hours or a week).

Below is a detailed table outlining the metrics for better understanding and monitoring of the Mithril signer node:

Metrics Description
Signer Registration Last Epoch The epoch during which the last signer registration occurred
Signer Registration Success Number of successful signer registrations
Signer Registration Errors Number of errors that occurred during signer registrations
Signature Registration Last Epoch The epoch during which the last signature registration occurred
Signature Registration Success Number of successful signature registrations
Signature Registration Errors Number of errors that occurred during signature registrations
State Machine Cycles Total number of state machine cycles
State Machine Cycles Success Number of state machine cycles that ended successfully
State Machine Cycles Errors Number of state machine cycles that ended due to an error

It is not concerning to have an error rate not exceeding 1% on the State Machine Cycles.

Feel free to reach out to us on the Discord channel for questions and/or help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Documentation to add/update
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants