diff --git a/Cargo.lock b/Cargo.lock index 21e04511710..a166231b104 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3848,7 +3848,7 @@ dependencies = [ [[package]] name = "mithril-signer" -version = "0.2.164" +version = "0.2.165" dependencies = [ "anyhow", "async-trait", diff --git a/docs/website/root/manual/getting-started/run-signer-node.md b/docs/website/root/manual/getting-started/run-signer-node.md index c45f08d4075..b4e86ad1f1f 100644 --- a/docs/website/root/manual/getting-started/run-signer-node.md +++ b/docs/website/root/manual/getting-started/run-signer-node.md @@ -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 diff --git a/docs/website/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md b/docs/website/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md index c45f08d4075..b4e86ad1f1f 100644 --- a/docs/website/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md +++ b/docs/website/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md @@ -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 diff --git a/mithril-signer/Cargo.toml b/mithril-signer/Cargo.toml index f37a02f657b..05c66311acd 100644 --- a/mithril-signer/Cargo.toml +++ b/mithril-signer/Cargo.toml @@ -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 } diff --git a/mithril-signer/src/metrics/mod.rs b/mithril-signer/src/metrics/mod.rs index 7034e37c781..5ea9f30ce87 100644 --- a/mithril-signer/src/metrics/mod.rs +++ b/mithril-signer/src/metrics/mod.rs @@ -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 =