Merge pull request #1833 from input-output-hk/dlachaume/update-activa…

…te-prometheus-endpoint-doc Add metrics table in the "Activate Prometheus endpoint" section
input-output-hk · Jul 16, 2024 · 4bc87f0 · 4bc87f0
2 parents 2d04e58 + a0d068f
commit 4bc87f0
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git 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/...ite/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md b/...ite/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
@@ -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
@@ -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 =