Skip to content

Commit fafabce

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

File tree

1 file changed

+37
-64
lines changed

1 file changed

+37
-64
lines changed

‎docs/Metrics.md‎

Lines changed: 37 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,52 @@
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 | Sub-Metrics |
8+
|---------------------------------|------------------------------------------|---------------------------------------------|-----------------------------------------------------|
9+
| `indexer_query_handler_seconds` | Histogram family of metrics for handler | deployment, allocation, sender, status_code | - Bucket: `indexer_query_handler_seconds_bucket`<br>- Count: `indexer_query_handler_seconds_count`<br>- Sum: `indexer_query_handler_seconds_sum` |
1310

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

18-
- `indexer_tap_invalid_total`: Counter of malformed TAP receipts in Header
13+
| Metric Name | Description | Labels | Sub-Metrics |
14+
|---------------------------------|------------------------------------------|---------------------------------------------|-----------------------------------------------------|
15+
| `indexer_receipt_failed_total` | Counter of receipts that failed TAP checks | deployment, allocation, sender | - |
16+
| `indexer_tap_invalid_total` | Counter of malformed TAP receipts in Header | - | - |
1917

2018
### Cost model
2119

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`
20+
| Metric Name | Description | Labels | Sub-Metrics |
21+
|--------------------------------------|--------------------------------------------------------|-----------------|-----------------------------------------------------|
22+
| `indexer_cost_model_seconds` | Histogram family of metrics for `cost_model` queries | deployment | - Bucket: `indexer_cost_model_seconds_bucket`<br>- Count: `indexer_cost_model_seconds_count`<br>- Sum: `indexer_cost_model_seconds_sum` |
23+
| `indexer_cost_model_failed_total` | Failure count | deployment | - |
24+
| `indexer_cost_model_invalid_total` | Cost model queries with invalid deployment ID | - | - |
25+
| `indexer_cost_model_batch_seconds` | Histogram for `cost_models` batch queries | - | - Bucket: `indexer_cost_model_batch_seconds_bucket`<br>- Count: `indexer_cost_model_batch_seconds_count`<br>- Sum: `indexer_cost_model_batch_seconds_sum` |
26+
| `indexer_cost_model_batch_size` | Gauge of deployment ID batch size | - | - |
27+
| `indexer_cost_model_batch_failed_total` | Total failed batch cost model queries | - | - |
28+
| `indexer_cost_model_batch_invalid_total` | Batch queries with invalid deployment IDs | - | - |
2829

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
30+
---
4531

4632
## Tap Agent Metrics
4733

4834
### Metrics related to sender
4935

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"]
36+
| Metric Name | Description | Labels | Sub-Metrics |
37+
|--------------------------------------|--------------------------------------------------|----------------|-----------------------------------------------------|
38+
| `tap_sender_denied` | Gauge for sender status (0: not denied, 1: denied) | sender | - |
39+
| `tap_sender_escrow_balance_grt_total`| Total balance in GRT in Escrow per sender | sender | - |
40+
| `tap_sender_fee_tracker_grt_total` | Total pending fees (receipts not yet aggregated) | sender | - |
41+
| `tap_max_fee_per_sender_grt_total` | Maximum amount willing to lose | sender | - |
42+
| `tap_rav_request_trigger_value` | Trigger value (max willing to lose / divisor) | sender | - |
43+
| `tap_rav_response_time_seconds` | Histogram of RAV response time per sender | sender | - Bucket: `tap_rav_response_time_seconds_bucket`<br>- Count: `tap_rav_response_time_seconds_count`<br>- Sum: `tap_rav_response_time_seconds_sum` |
44+
| `tap_closed_sender_allocation_total` | Counter of allocations closed | sender | - |
45+
46+
### Metrics related to specific allocations for a sender
47+
48+
| Metric Name | Description | Labels | Sub-Metrics |
49+
|--------------------------------------|--------------------------------------------------|------------------------|-----------------------------------------------------|
50+
| `tap_invalid_receipt_fees_grt_total` | Sum of invalid receipt fees (GRT) per allocation | sender, allocation | - |
51+
| `tap_pending_rav_grt_total` | Pending RAVs (not redeemed) per allocation | sender, allocation | - |
52+
| `tap_unaggregated_fees_grt_total` | Unaggregated fees per allocation (GRT) | sender, allocation | - |
53+
| `tap_ravs_created_total` | Counter of RAV requests created per allocation | sender, allocation | - |
54+
| `tap_ravs_failed_total` | Counter of RAV requests failed per allocation | sender, allocation | - |
55+
| `tap_receipts_received_total` | Counter of receipts received per allocation | sender, allocation | - |

0 commit comments

Comments
 (0)