Skip to content

Commit eb40257

Browse files
committed
Add metrics table in the "Activate Prometheus endpoint" section of the "Run a Mithril signer as an SPO" guide
1 parent 2d04e58 commit eb40257

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

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

0 commit comments

Comments
 (0)