Skip to content

Commit f9ec8aa

Browse files
gusinaciogusinacio
committed
docs: update metrics to table
Signed-off-by: Gustavo Inacio <[email protected]>
1 parent 6e49d5e commit f9ec8aa

File tree

1 file changed

+46
-65
lines changed

1 file changed

+46
-65
lines changed

‎docs/Metrics.md‎

Lines changed: 46 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,60 @@
44

55
### Main handler
66

7-
- `indexer_query_handler_seconds`: Histogram family of metrics for the main handler
8-
- Labels: ["deployment", "allocation", "sender", "status_code"]
9-
- Metrics:
10-
- `indexer_query_handler_seconds_bucket`
11-
- `indexer_query_handler_seconds_count`
12-
- `indexer_query_handler_seconds_sum`
7+
| Metric Name | Description | Labels |
8+
|---------------------------------------------|---------------------------------------------------------------------------------------------|---------------------------------------------|
9+
| `indexer_query_handler_seconds_bucket` | Histogram buckets for the duration of requests handled by the main query handler, in seconds. | deployment, allocation, sender, status_code |
10+
| `indexer_query_handler_seconds_count` | Total number of requests handled by the main query handler. | deployment, allocation, sender, status_code |
11+
| `indexer_query_handler_seconds_sum` | Total duration of all requests handled by the main query handler, in seconds. | deployment, allocation, sender, status_code |
1312

1413
### TAP related
15-
- `indexer_receipt_failed_total`: Counter of receipts that failed TAP checks
16-
- Labels: ["deployment", "allocation", "sender"]
1714

18-
- `indexer_tap_invalid_total`: Counter of malformed TAP receipts in Header
15+
| Metric Name | Description | Labels |
16+
|---------------------------------------------|---------------------------------------------------------------------------------------------|---------------------------------------------|
17+
| `indexer_receipt_failed_total` | Total number of receipts that failed TAP validation. | deployment, allocation, sender |
18+
| `indexer_tap_invalid_total` | Total number of malformed TAP receipts detected in headers. | - |
1919

2020
### Cost model
2121

22-
- `indexer_cost_model_seconds`: Histogram family of metrics for single `cost_model` query
23-
- Labels: ["deployment"]
24-
- Metrics:
25-
- `indexer_cost_model_seconds_bucket`
26-
- `indexer_cost_model_seconds_count`
27-
- `indexer_cost_model_seconds_sum`
28-
29-
- `indexer_cost_model_failed_total`: Failure count while
30-
- Labels: ["deployment"]
31-
32-
- `indexer_cost_model_invalid_total`: Cost model queries with invalid deployment id
33-
34-
- `indexer_cost_model_batch_seconds`: Family Histogram of metrics for `cost_models` batch query
35-
- Metrics:
36-
- `indexer_cost_model_batch_seconds_bucket`
37-
- `indexer_cost_model_batch_seconds_count`
38-
- `indexer_cost_model_batch_seconds_sum`
39-
40-
- `indexer_cost_model_batch_size`: Gauge of the size of deployment ids cost model batch queries got
41-
42-
- `indexer_cost_model_batch_failed_total`: Total failed batch cost model queries
43-
44-
- `indexer_cost_model_batch_invalid_total`: Batch cost model queries with invalid deployment ids
22+
| Metric Name | Description | Labels |
23+
|---------------------------------------------|---------------------------------------------------------------------------------------------|-----------------|
24+
| `indexer_cost_model_seconds_bucket` | Histogram buckets for the duration of individual `cost_model` queries, in seconds. | deployment |
25+
| `indexer_cost_model_seconds_count` | Total number of `cost_model` queries processed. | deployment |
26+
| `indexer_cost_model_seconds_sum` | Total duration of all `cost_model` queries processed, in seconds. | deployment |
27+
| `indexer_cost_model_failed_total` | Total number of failed `cost_model` queries. | deployment |
28+
| `indexer_cost_model_invalid_total` | Total number of `cost_model` queries with invalid deployment IDs. | - |
29+
| `indexer_cost_model_batch_seconds_bucket` | Histogram buckets for the duration of batch `cost_model` queries, in seconds. | - |
30+
| `indexer_cost_model_batch_seconds_count` | Total number of batch `cost_model` queries processed. | - |
31+
| `indexer_cost_model_batch_seconds_sum` | Total duration of all batch `cost_model` queries processed, in seconds. | - |
32+
| `indexer_cost_model_batch_size` | Gauge of the size of deployment ID batches in `cost_model` queries. | - |
33+
| `indexer_cost_model_batch_failed_total` | Total number of failed batch `cost_model` queries. | - |
34+
| `indexer_cost_model_batch_invalid_total` | Total number of batch `cost_model` queries with invalid deployment IDs. | - |
35+
36+
---
4537

4638
## Tap Agent Metrics
4739

4840
### Metrics related to sender
4941

50-
- `tap_sender_denied`: Gauge for sender status. 0 if sender is not denied, 1 if it is denied
51-
- Labels: ["sender"]
52-
- `tap_sender_escrow_balance_grt_total`: Gauge with total balance in GRT in Escrow per sender.
53-
- Labels: ["sender"]
54-
- `tap_sender_fee_tracker_grt_total`: Gauge with total pending fees (Receipts not yet aggregated) per sender.
55-
- Labels: ["sender"]
56-
- `tap_max_fee_per_sender_grt_total`: Gauge with max amount willing to lose.
57-
- Labels: ["sender"]
58-
- `tap_rav_request_trigger_value`: Gauge with trigger value (max willing to lose / trigger divisor).
59-
- Labels: ["sender"]
60-
- `tap_rav_response_time_seconds`: Histogram family metrics for RAV response time per sender.
61-
- Labels: ["sender"]
62-
- Metrics:
63-
- `tap_rav_response_time_seconds_bucket`
64-
- `tap_rav_response_time_seconds_count`
65-
- `tap_rav_response_time_seconds_sum`
66-
67-
- `tap_closed_sender_allocation_total`: Counter of allocations closed.
68-
- Labels: ["sender"]
69-
70-
### Metrics related to a an specific allocation for a sender
71-
- `tap_invalid_receipt_fees_grt_total`: Sum of invalid receipt fees per (sender, allocation) pair in GRT.
72-
- Labels: ["sender", "allocation"]
73-
- `tap_pending_rav_grt_total`: Sum of Pending RAVs (RAVs not redeemed) per (sender, allocation) pair in GRT.
74-
- Labels: ["sender", "allocation"]
75-
- `tap_unaggregated_fees_grt_total`: Sum of Unaggregated Fees (Receipts not yet aggregated) per (sender, allocation) pair in GRT.
76-
- Labels: ["sender", "allocation"]
77-
- `tap_ravs_created_total`: Counter of RAV requests created per (sender, allocation).
78-
- Labels: ["sender", "allocation"]
79-
- `tap_ravs_failed_total`: Counter of RAV requests failed per (sender, allocation).
80-
- Labels: ["sender", "allocation"]
81-
- `tap_receipts_received_total`: Counter of amount of receipts received per (sender, allocation).
82-
- Labels: ["sender", "allocation"]
42+
| Metric Name | Description | Labels |
43+
|---------------------------------------------|---------------------------------------------------------------------------------------------|-----------------|
44+
| `tap_sender_denied` | Indicates whether a sender is denied (0: not denied, 1: denied). | sender |
45+
| `tap_sender_escrow_balance_grt_total` | Total balance in GRT held in escrow for a sender. | sender |
46+
| `tap_sender_fee_tracker_grt_total` | Total pending fees in GRT for a sender (unaggregated receipts). | sender |
47+
| `tap_max_fee_per_sender_grt_total` | Maximum amount in GRT a sender is willing to lose. | sender |
48+
| `tap_rav_request_trigger_value` | Trigger value calculated as the maximum amount willing to lose divided by a divisor. | sender |
49+
| `tap_rav_response_time_seconds_bucket` | Histogram buckets for the response time of RAV requests, in seconds. | sender |
50+
| `tap_rav_response_time_seconds_count` | Total number of RAV requests processed. | sender |
51+
| `tap_rav_response_time_seconds_sum` | Total response time for all RAV requests, in seconds. | sender |
52+
| `tap_closed_sender_allocation_total` | Total number of allocations closed for a sender. | sender |
53+
54+
### Metrics related to specific allocations for a sender
55+
56+
| Metric Name | Description | Labels |
57+
|---------------------------------------------|---------------------------------------------------------------------------------------------|------------------------|
58+
| `tap_invalid_receipt_fees_grt_total` | Total value of invalid receipt fees in GRT for each sender-allocation pair. | sender, allocation |
59+
| `tap_pending_rav_grt_total` | Total value of pending RAVs (not redeemed) in GRT for each sender-allocation pair. | sender, allocation |
60+
| `tap_unaggregated_fees_grt_total` | Total value of unaggregated fees in GRT for each sender-allocation pair. | sender, allocation |
61+
| `tap_ravs_created_total` | Total number of RAV requests created for each sender-allocation pair. | sender, allocation |
62+
| `tap_ravs_failed_total` | Total number of RAV requests that failed for each sender-allocation pair. | sender, allocation |
63+
| `tap_receipts_received_total` | Total number of receipts received for each sender-allocation pair. | sender, allocation |

0 commit comments

Comments
 (0)