Skip to content

Commit 4159eae

Browse files
pwilczynskiclearcodelutter
authored andcommitted
Introduce metrics.md documentation
1 parent f4c4980 commit 4159eae

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

docs/metrics.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
graph-node provides the following metrics via Prometheus endpoint on 8040 port by default:
2+
- `deployment_block_processing_duration`
3+
Measures **duration of block processing** for a subgraph deployment
4+
- `deployment_block_trigger_count`
5+
Measures the **number of triggers in each** block for a subgraph deployment
6+
- `deployment_count`
7+
Counts the number of deployments currently being indexed by the graph-node.
8+
- `deployment_eth_rpc_errors`
9+
Counts **eth** **rpc request errors** for a subgraph deployment
10+
- `deployment_eth_rpc_request_duration`
11+
Measures **eth** **rpc request duration** for a subgraph deployment
12+
- `deployment_failed`
13+
Boolean gauge to indicate **whether the deployment has failed** (1 == failed)
14+
- `deployment_handler_execution_time`
15+
Measures the **execution time for handlers**
16+
- `deployment_head`
17+
Track the **head block number** for a deployment. Example:
18+
19+
```protobuf
20+
deployment_head{deployment="QmaeWFYbPwmXEk7UuACmkqgPq2Pba5t2RYdJtEyvAUmrxg",network="mumbai",shard="primary"} 19509077
21+
```
22+
23+
- `deployment_host_fn_execution_time`
24+
Measures the **execution time for host functions**
25+
- `deployment_reverted_blocks`
26+
Track the **last reverted block** for a subgraph deployment
27+
- `deployment_sync_secs`
28+
total **time spent syncing**
29+
- `deployment_transact_block_operations_duration`
30+
Measures **duration of commiting all the entity operations** in a block and **updating the subgraph pointer**
31+
- `deployment_trigger_processing_duration`
32+
Measures **duration of trigger processing** for a subgraph deployment
33+
- `eth_rpc_errors`
34+
Counts **eth rpc request errors**
35+
- `eth_rpc_request_duration`
36+
Measures **eth rpc request duration**
37+
- `ethereum_chain_head_number`
38+
Block **number of the most recent block synced from Ethereum**. Example:
39+
40+
```protobuf
41+
ethereum_chain_head_number{network="mumbai"} 20045294
42+
```
43+
44+
- `metrics_register_errors`
45+
Counts **Prometheus metrics register errors**
46+
- `metrics_unregister_errors`
47+
Counts **Prometheus metrics unregister errors**
48+
- `query_cache_status_count`
49+
Count **toplevel GraphQL fields executed** and their cache status
50+
- `query_effort_ms`
51+
Moving **average of time spent running queries**
52+
- `query_execution_time`
53+
**Execution time for successful GraphQL queries**
54+
- `query_result_max`
55+
the **maximum size of a query result** (in CacheWeight)
56+
- `query_result_size`
57+
the **size of the result of successful GraphQL queries** (in CacheWeight)
58+
- `query_semaphore_wait_ms`
59+
Moving **average of time spent on waiting for postgres query semaphore**
60+
- `query_kill_rate`
61+
The rate at which the load manager kills queries
62+
- `registered_metrics`
63+
Tracks the **number of registered metrics** on the node
64+
- `store_connection_checkout_count`
65+
The **number of Postgres connections** currently **checked out**
66+
- `store_connection_error_count`
67+
The **number of Postgres connections errors**
68+
- `store_connection_wait_time_ms`
69+
**Average connection wait time**

0 commit comments

Comments
 (0)