Skip to content

Commit 309216e

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

File tree

1 file changed

+50
-65
lines changed

1 file changed

+50
-65
lines changed

‎docs/Metrics.md‎

Lines changed: 50 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,64 @@
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` | Histogram family of metrics for the main handler | deployment, allocation, sender, status_code |
10+
| &nbsp;&nbsp;&nbsp;`indexer_query_handler_seconds_bucket` | Sub-metric: Buckets for the histogram | - |
11+
| &nbsp;&nbsp;&nbsp;`indexer_query_handler_seconds_count` | Sub-metric: Count of events | - |
12+
| &nbsp;&nbsp;&nbsp;`indexer_query_handler_seconds_sum` | Sub-metric: Sum of durations | - |
1313

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

18-
- `indexer_tap_invalid_total`: Counter of malformed TAP receipts in Header
16+
| Metric Name | Description | Labels |
17+
|---------------------------------------------|------------------------------------------------------------|---------------------------------------------|
18+
| `indexer_receipt_failed_total` | Counter of receipts that failed TAP checks | deployment, allocation, sender |
19+
| `indexer_tap_invalid_total` | Counter of malformed TAP receipts in Header | - |
1920

2021
### Cost model
2122

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
23+
| Metric Name | Description | Labels |
24+
|---------------------------------------------|------------------------------------------------------------|---------------------------------------------|
25+
| `indexer_cost_model_seconds` | Histogram family of metrics for single `cost_model` query | deployment |
26+
| &nbsp;&nbsp;&nbsp;`indexer_cost_model_seconds_bucket` | Sub-metric: Buckets for the histogram | - |
27+
| &nbsp;&nbsp;&nbsp;`indexer_cost_model_seconds_count` | Sub-metric: Count of events | - |
28+
| &nbsp;&nbsp;&nbsp;`indexer_cost_model_seconds_sum` | Sub-metric: Sum of durations | - |
29+
| `indexer_cost_model_failed_total` | Failure count | deployment |
30+
| `indexer_cost_model_invalid_total` | Cost model queries with invalid deployment id | - |
31+
| `indexer_cost_model_batch_seconds` | Family Histogram of metrics for `cost_models` batch query | - |
32+
| &nbsp;&nbsp;&nbsp;`indexer_cost_model_batch_seconds_bucket` | Sub-metric: Buckets for the histogram | - |
33+
| &nbsp;&nbsp;&nbsp;`indexer_cost_model_batch_seconds_count` | Sub-metric: Count of events | - |
34+
| &nbsp;&nbsp;&nbsp;`indexer_cost_model_batch_seconds_sum` | Sub-metric: Sum of durations | - |
35+
| `indexer_cost_model_batch_size` | Gauge of the size of deployment IDs in cost model batch queries | - |
36+
| `indexer_cost_model_batch_failed_total` | Total failed batch cost model queries | - |
37+
| `indexer_cost_model_batch_invalid_total` | Batch cost model queries with invalid deployment IDs | - |
38+
39+
---
4540

4641
## Tap Agent Metrics
4742

4843
### Metrics related to sender
4944

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"]
45+
| Metric Name | Description | Labels |
46+
|---------------------------------------------|------------------------------------------------------------|---------------------------------------------|
47+
| `tap_sender_denied` | Gauge for sender status. 0 if sender is not denied, 1 if it is denied | sender |
48+
| `tap_sender_escrow_balance_grt_total` | Gauge with total balance in GRT in Escrow per sender | sender |
49+
| `tap_sender_fee_tracker_grt_total` | Gauge with total pending fees (Receipts not yet aggregated) per sender | sender |
50+
| `tap_max_fee_per_sender_grt_total` | Gauge with max amount willing to lose | sender |
51+
| `tap_rav_request_trigger_value` | Gauge with trigger value (max willing to lose / trigger divisor) | sender |
52+
| `tap_rav_response_time_seconds` | Histogram family metrics for RAV response time per sender | sender |
53+
| &nbsp;&nbsp;&nbsp;`tap_rav_response_time_seconds_bucket` | Sub-metric: Buckets for the histogram | - |
54+
| &nbsp;&nbsp;&nbsp;`tap_rav_response_time_seconds_count` | Sub-metric: Count of events | - |
55+
| &nbsp;&nbsp;&nbsp;`tap_rav_response_time_seconds_sum` | Sub-metric: Sum of durations | - |
56+
| `tap_closed_sender_allocation_total` | Counter of allocations closed | sender |
57+
58+
### Metrics related to a specific allocation for a sender
59+
60+
| Metric Name | Description | Labels |
61+
|---------------------------------------------|------------------------------------------------------------|---------------------------------------------|
62+
| `tap_invalid_receipt_fees_grt_total` | Sum of invalid receipt fees per (sender, allocation) pair in GRT | sender, allocation |
63+
| `tap_pending_rav_grt_total` | Sum of Pending RAVs (RAVs not redeemed) per (sender, allocation) pair in GRT | sender, allocation |
64+
| `tap_unaggregated_fees_grt_total` | Sum of Unaggregated Fees (Receipts not yet aggregated) per (sender, allocation) pair in GRT | sender, allocation |
65+
| `tap_ravs_created_total` | Counter of RAV requests created per (sender, allocation) | sender, allocation |
66+
| `tap_ravs_failed_total` | Counter of RAV requests failed per (sender, allocation) | sender, allocation |
67+
| `tap_receipts_received_total` | Counter of amount of receipts received per (sender, allocation) | sender, allocation |

0 commit comments

Comments
 (0)