Skip to content

Commit 4bc87f0

Browse files
dlachaumedlachaume
authored
Merge pull request #1833 from input-output-hk/dlachaume/update-activate-prometheus-endpoint-doc
Add metrics table in the "Activate Prometheus endpoint" section
2 parents 2d04e58 + a0d068f commit 4bc87f0

File tree

5 files changed

+27
-5
lines changed

5 files changed

+27
-5
lines changed

‎Cargo.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/website/root/manual/getting-started/run-signer-node.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,17 @@ tail -f /var/log/syslog | grep mithril-signer
447447

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

450+
| Metrics | Description |
451+
| --------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
452+
| **mithril_signer_signer_registration_success_since_startup** | Number of successful signer registrations since startup on a Mithril signer node |
453+
| **mithril_signer_signer_registration_total_since_startup** | Number of signer registrations since startup on a Mithril signer node |
454+
| **mithril_signer_signer_registration_success_last_epoch** | Latest epoch at which signer successfully registered on a Mithril signer node |
455+
| **mithril_signer_signature_registration_success_since_startup** | Number of successful signature registrations since startup on a Mithril signer node |
456+
| **mithril_signer_signature_registration_total_since_startup** | Number of signature registrations since startup on a Mithril signer node |
457+
| **mithril_signer_signature_registration_success_last_epoch** | Latest epoch at which signature successfully registered on a Mithril signer node |
458+
| **mithril_signer_runtime_cycle_success_since_startup** | Number of successful runtime cycles since startup on a Mithril signer node |
459+
| **mithril_signer_runtime_cycle_total_since_startup** | Number of runtime cycles since startup on a Mithril signer node |
460+
450461
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:
451462

452463
```bash

‎docs/website/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,17 @@ tail -f /var/log/syslog | grep mithril-signer
447447

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

450+
| Metrics | Description |
451+
| --------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
452+
| **mithril_signer_signer_registration_success_since_startup** | Number of successful signer registrations since startup on a Mithril signer node |
453+
| **mithril_signer_signer_registration_total_since_startup** | Number of signer registrations since startup on a Mithril signer node |
454+
| **mithril_signer_signer_registration_success_last_epoch** | Latest epoch at which signer successfully registered on a Mithril signer node |
455+
| **mithril_signer_signature_registration_success_since_startup** | Number of successful signature registrations since startup on a Mithril signer node |
456+
| **mithril_signer_signature_registration_total_since_startup** | Number of signature registrations since startup on a Mithril signer node |
457+
| **mithril_signer_signature_registration_success_last_epoch** | Latest epoch at which signature successfully registered on a Mithril signer node |
458+
| **mithril_signer_runtime_cycle_success_since_startup** | Number of successful runtime cycles since startup on a Mithril signer node |
459+
| **mithril_signer_runtime_cycle_total_since_startup** | Number of runtime cycles since startup on a Mithril signer node |
460+
450461
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:
451462

452463
```bash

‎mithril-signer/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "mithril-signer"
3-
version = "0.2.164"
3+
version = "0.2.165"
44
description = "A Mithril Signer"
55
authors = { workspace = true }
66
edition = { workspace = true }

‎mithril-signer/src/metrics/mod.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ pub const SIGNATURE_REGISTRATION_SUCCESS_SINCE_STARTUP_METRIC_NAME: &str =
3333
"mithril_signer_signature_registration_success_since_startup";
3434
/// 'signature_registration_success_since_startup' metric help
3535
pub const SIGNATURE_REGISTRATION_SUCCESS_SINCE_STARTUP_METRIC_HELP: &str =
36-
"Number of successful signature registrations since startup on a Mithril signature node";
36+
"Number of successful signature registrations since startup on a Mithril signer node";
3737

3838
/// 'signature_registration_total_since_startup' metric name
3939
pub const SIGNATURE_REGISTRATION_TOTAL_SINCE_STARTUP_METRIC_NAME: &str =
4040
"mithril_signer_signature_registration_total_since_startup";
4141
/// 'signature_registration_total_since_startup' metric help
4242
pub const SIGNATURE_REGISTRATION_TOTAL_SINCE_STARTUP_METRIC_HELP: &str =
43-
"Number of signature registrations since startup on a Mithril signature node";
43+
"Number of signature registrations since startup on a Mithril signer node";
4444

4545
/// 'signature_registration_success_last_epoch' metric name
4646
pub const SIGNATURE_REGISTRATION_SUCCESS_LAST_EPOCH_METRIC_NAME: &str =
4747
"mithril_signer_signature_registration_success_last_epoch";
4848
/// 'signature_registration_success_last_epoch' metric help
4949
pub const SIGNATURE_REGISTRATION_SUCCESS_LAST_EPOCH_METRIC_HELP: &str =
50-
"Latest epoch at which signature successfully registered on a Mithril signature node";
50+
"Latest epoch at which signature successfully registered on a Mithril signer node";
5151

5252
/// 'runtime_cycle_success_since_startup' metric name
5353
pub const RUNTIME_CYCLE_SUCCESS_SINCE_STARTUP_METRIC_NAME: &str =

0 commit comments

Comments
 (0)