Skip to content

Add metrics table in the "Activate Prometheus endpoint" section #1833

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 16, 2024
Merged

Add metrics table in the "Activate Prometheus endpoint" section #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb40257
Add metrics table in the "Activate Prometheus endpoint" section of th…
dlachaume Jul 16, 2024
f2e4b1b
Fix typo in `metrics` constants used by Prometheus endpoint
dlachaume Jul 16, 2024
a0d068f
Bump `mithril-signer` crate version from '0.2.164' to '0.2.165'
dlachaume Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions docs/website/root/manual/getting-started/run-signer-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,17 @@ tail -f /var/log/syslog | grep mithril-signer

The Mithril signer node can expose basic metrics on a Prometheus endpoint, which is not activated by default.

| Metrics | Description |
| --------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| **mithril_signer_signer_registration_success_since_startup** | Number of successful signer registrations since startup on a Mithril signer node |
| **mithril_signer_signer_registration_total_since_startup** | Number of signer registrations since startup on a Mithril signer node |
| **mithril_signer_signer_registration_success_last_epoch** | Latest epoch at which signer successfully registered on a Mithril signer node |
| **mithril_signer_signature_registration_success_since_startup** | Number of successful signature registrations since startup on a Mithril signer node |
| **mithril_signer_signature_registration_total_since_startup** | Number of signature registrations since startup on a Mithril signer node |
| **mithril_signer_signature_registration_success_last_epoch** | Latest epoch at which signature successfully registered on a Mithril signer node |
| **mithril_signer_runtime_cycle_success_since_startup** | Number of successful runtime cycles since startup on a Mithril signer node |
| **mithril_signer_runtime_cycle_total_since_startup** | Number of runtime cycles since startup on a Mithril signer node |

In order to expose metrics on the endpoint, you need to append the following environment variable to your environment file. In that case, the metrics server will listen on the `9090` port:

```bash
Expand Down
11 changes: 11 additions & 0 deletions ...ite/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,17 @@ tail -f /var/log/syslog | grep mithril-signer

The Mithril signer node can expose basic metrics on a Prometheus endpoint, which is not activated by default.

| Metrics | Description |
| --------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| **mithril_signer_signer_registration_success_since_startup** | Number of successful signer registrations since startup on a Mithril signer node |
| **mithril_signer_signer_registration_total_since_startup** | Number of signer registrations since startup on a Mithril signer node |
| **mithril_signer_signer_registration_success_last_epoch** | Latest epoch at which signer successfully registered on a Mithril signer node |
| **mithril_signer_signature_registration_success_since_startup** | Number of successful signature registrations since startup on a Mithril signer node |
| **mithril_signer_signature_registration_total_since_startup** | Number of signature registrations since startup on a Mithril signer node |
| **mithril_signer_signature_registration_success_last_epoch** | Latest epoch at which signature successfully registered on a Mithril signer node |
| **mithril_signer_runtime_cycle_success_since_startup** | Number of successful runtime cycles since startup on a Mithril signer node |
| **mithril_signer_runtime_cycle_total_since_startup** | Number of runtime cycles since startup on a Mithril signer node |

In order to expose metrics on the endpoint, you need to append the following environment variable to your environment file. In that case, the metrics server will listen on the `9090` port:

```bash
Expand Down
2 changes: 1 addition & 1 deletion mithril-signer/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mithril-signer"
version = "0.2.164"
version = "0.2.165"
description = "A Mithril Signer"
authors = { workspace = true }
edition = { workspace = true }
Expand Down
6 changes: 3 additions & 3 deletions mithril-signer/src/metrics/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@ pub const SIGNATURE_REGISTRATION_SUCCESS_SINCE_STARTUP_METRIC_NAME: &str =
"mithril_signer_signature_registration_success_since_startup";
/// 'signature_registration_success_since_startup' metric help
pub const SIGNATURE_REGISTRATION_SUCCESS_SINCE_STARTUP_METRIC_HELP: &str =
"Number of successful signature registrations since startup on a Mithril signature node";
"Number of successful signature registrations since startup on a Mithril signer node";

/// 'signature_registration_total_since_startup' metric name
pub const SIGNATURE_REGISTRATION_TOTAL_SINCE_STARTUP_METRIC_NAME: &str =
"mithril_signer_signature_registration_total_since_startup";
/// 'signature_registration_total_since_startup' metric help
pub const SIGNATURE_REGISTRATION_TOTAL_SINCE_STARTUP_METRIC_HELP: &str =
"Number of signature registrations since startup on a Mithril signature node";
"Number of signature registrations since startup on a Mithril signer node";

/// 'signature_registration_success_last_epoch' metric name
pub const SIGNATURE_REGISTRATION_SUCCESS_LAST_EPOCH_METRIC_NAME: &str =
"mithril_signer_signature_registration_success_last_epoch";
/// 'signature_registration_success_last_epoch' metric help
pub const SIGNATURE_REGISTRATION_SUCCESS_LAST_EPOCH_METRIC_HELP: &str =
"Latest epoch at which signature successfully registered on a Mithril signature node";
"Latest epoch at which signature successfully registered on a Mithril signer node";

/// 'runtime_cycle_success_since_startup' metric name
pub const RUNTIME_CYCLE_SUCCESS_SINCE_STARTUP_METRIC_NAME: &str =
Expand Down