From 47b11f9e988743da58066ee7671c07f50a913760 Mon Sep 17 00:00:00 2001 From: sweexordious Date: Wed, 3 Jan 2024 18:21:09 +0100 Subject: [PATCH] docs: metrics documentation --- docs/orchestrator.md | 4 ++-- docs/relayer.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/orchestrator.md b/docs/orchestrator.md index 4672b5a3..3137e241 100644 --- a/docs/orchestrator.md +++ b/docs/orchestrator.md @@ -261,7 +261,7 @@ The orchestrator supports metrics that describe its runtime and gives more infor - `orchestrator_processed_nonces_counter`: The count of the total number of nonces that have been processed by the orchestrator. During normal conditions, this number will be incremented by 1 every hour, i.e. 400 blocks which is the current data commitment window. The health of the orchestrator can be determined using this metric via checking if it's been constantly signing nonces. If the counter wasn't incremented for more than an hour, the orchestrator might be failing. - `orchestrator_failed_nonces_counter`: The count of the number of nonces that the orchestrator tried to process, but failed. These nonces might be re-queued to be reprocessed subsequently. If the orchestrator manages to process them correctly, the `orchestrator_processed_nonces_counter` will be incremented. Otherwise, they might be re-enqueued to be re-processed. -- `orchestrator_failed_nonces_counter`: The count of the number of nonces that failed to be processed by the orchestrator, but were re-enqueued. +- `orchestrator_reprocessed_nonces_counter`: The count of the number of nonces that failed to be processed by the orchestrator, but were re-enqueued. - `orchestrator_processing_time`: The time it takes for a nonce to be processed or fail after it was picked by the orchestrator processor. To enable these metrics, make sure to set the `metrics` to true in the orchestrator configuration file: @@ -271,7 +271,7 @@ To enable these metrics, make sure to set the `metrics` to true in the orchestra metrics = "true" ``` -And setup a correct endpoint to connect to an otel collector, by default it targets the `"localhost:4318"` endpoint. These can also be setup using the command line flags. +And setup a correct endpoint to connect to an [otel collector](https://opentelemetry.io/docs/collector/installation/), by default it targets the `"localhost:4318"` endpoint. These can also be setup using the command line flags. The orchestrator provides also the LibP2P native metrics. These are also enabled when the above parameter is set to `true` and are served, by default, to the `"localhost:30001/metrics"`, which can be updated using the orchestrator config file or the command line flags. diff --git a/docs/relayer.md b/docs/relayer.md index 44361bb1..89478fee 100644 --- a/docs/relayer.md +++ b/docs/relayer.md @@ -137,8 +137,8 @@ To enable these metrics, make sure to set the `metrics` to true in the relayer c metrics = "true" ``` -And setup a correct endpoint to connect to an otel collector, by default it targets the `"localhost:4318"` endpoint. These can also be setup using the command line flags. +And setup a correct endpoint to connect to an [otel collector](https://opentelemetry.io/docs/collector/installation/), by default it targets the `"localhost:4318"` endpoint. These can also be setup using the command line flags. The relayer provides also the LibP2P native metrics. These are also enabled when the above parameter is set to `true` and are served, by default, to the `"localhost:30001/metrics"`, which can be updated using the relayer config file or the command line flags. -An example configuration is provided in the `e2e/telemetry` folder along with the corresponding docker-compose file. +An example configuration is provided in the `e2e/telemetry` folder along with the corresponding docker-compose file `e2e/docker-compose.yml`.