mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2025-01-08 18:51:19 +00:00
Add clientstats spec as a README.md (#8977)
Co-authored-by: Raul Jordan <raul@prysmaticlabs.com>
This commit is contained in:
Preston Van Loon
GitHub
parent
5aac06f04e
commit
693fdf87bb
120
shared/clientstats/README.md
Normal file
120
shared/clientstats/README.md
Normal file
@ -0,0 +1,120 @@
|
||||
# Client stats reporting
|
||||
|
||||
## Specification
|
||||
|
||||
The request JSON object is a non-nested object with the following properties. The process refers to which process data is associated with the request.
|
||||
|
||||
| Property | Type | Process | Description |
|
||||
|-------------------------------------|---------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| version | int | Every request | Stats data specification version, current only `1` is accepted |
|
||||
| timestamp | long | Every request | Unix timestamp in milliseconds |
|
||||
| process | string (enum) | Every request | Enum values: validator, beaconnode, system |
|
||||
| cpu_process_seconds_total | long | beaconnode, validator | CPU seconds consumed by the process |
|
||||
| memory_process_bytes | long | beaconnode, validator | Number of bytes allocated to the process |
|
||||
| client_name | string | beaconnode, validator | Name of the client type. Ex: prysm, lighthouse, nimbus, teku |
|
||||
| client_version | string | beaconnode, validator | Client version. Ex: 1.0.0-beta.0 |
|
||||
| client_build | int | beaconnode, validator | Integer representation of build for easier comparison |
|
||||
| sync_eth2_fallback_configured | bool | validator | Whether or not the process has a fallback eth2 endpoint configured |
|
||||
| sync_eth2_fallback_connected | bool | validator | Weather or not the process has connected to the failover eth2 endpoint. A true value indicates a failed or interrupted connection with the primary eth2 endpoint. |
|
||||
| disk_beaconchain_bytes_total | long | beaconchain | The amount of data consumed on disk by the beacon chain's database. |
|
||||
| network_libp2p_bytes_total_receive | long | beaconchain | The number of bytes received via libp2p traffic |
|
||||
| network_libp2p_bytes_total_transmit | long | beaconchain | The number of bytes transmitted via libp2p traffic |
|
||||
| network_peers_connected | int | beaconchain | The number of peers currently connected to the beacon chain |
|
||||
| sync_eth1_connected | bool | beaconchain | Whether or not the beacon chain node is connected to a _synced_ eth1 node |
|
||||
| sync_eth2_synced | bool | beaconchain | Whether or not the beacon chain node is in sync with the beacon chain network |
|
||||
| sync_beacon_head_slot | long | beaconchain | The head slot number. |
|
||||
| sync_eth1_fallback_configured | bool | beaconchain | Whether or not the beacon chain node has a fallback eth1 endpoint configured. |
|
||||
| sync_eth1_fallback_connected | bool | beaconchain | Whether or not the beacon chain node is connected to a fallback eth1 endpoint. A true value indicates a failed or interrupted connection with the primary eth1 endpoint. |
|
||||
| slasher_active | bool | beaconchain | Whether or not slasher functionality is enabled. |
|
||||
| validator_total | int | validator | The number of validating keys in use. |
|
||||
| validator_active | int | validator | The number of validator keys that are currently active. |
|
||||
| cpu_cores | int | system | The number of CPU cores available on the host machine |
|
||||
| cpu_threads | int | system | The number of CPU threads available on the host machine |
|
||||
| cpu_node_system_seconds_total | long | system | Overall CPU seconds observed on the host machine for all processes. |
|
||||
| cpu_node_user_seconds_total | long | system | ?? |
|
||||
| cpu_node_iowait_seconds_total | long | system | ?? |
|
||||
| cpu_node_idle_seconds_total | long | system | ?? |
|
||||
| memory_node_bytes_total | long | system | ?? |
|
||||
| memory_node_bytes_free | long | system | ?? |
|
||||
| memory_node_bytes_cached | long | system | ?? |
|
||||
| memory_node_bytes_bufferd | long | system | ?? |
|
||||
| disk_node_bytes_total | long | system | ?? |
|
||||
| disk_node_bytes_free | long | system | ?? |
|
||||
| disk_node_io_seconds | long | system | ?? |
|
||||
| disk_node_reads_total | long | system | ?? |
|
||||
| disk_node_writes_total | long | system | ?? |
|
||||
| network_node_bytes_total_receive | long | system | ?? |
|
||||
| network_node_bytes_total_transmit | long | system | ?? |
|
||||
| misc_node_boot_ts_system | long | system | ?? |
|
||||
| misc_os | string | system | Enum values: lin, win, mac, unk |
|
||||
|
||||
The client stats reporter will submit a request object for each process type. The report request may
|
||||
submit a list of data or a single JSON object.
|
||||
|
||||
### Examples
|
||||
|
||||
POST https://beaconcha.in/api/v1/stats/$API_KEY/$MACHINE_NAME
|
||||
|
||||
**Single object payload**
|
||||
|
||||
```json
|
||||
{
|
||||
"version": 1,
|
||||
"timestamp": 11234567,
|
||||
"process": "validator",
|
||||
"cpu_process_seconds_total": 1234567,
|
||||
"memory_process_bytes": 654321,
|
||||
"client_name": "lighthouse",
|
||||
"client_version": "1.1.2",
|
||||
"client_build": 12,
|
||||
"sync_eth2_fallback_configured": false,
|
||||
"sync_eth2_fallback_connected": false,
|
||||
"validator_total": 3,
|
||||
"validator_active": 2
|
||||
}
|
||||
```
|
||||
|
||||
**Multiple object payload**
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"version":1,
|
||||
"timestamp":1618835497239,
|
||||
"process":"beaconnode",
|
||||
"cpu_process_seconds_total":6925,
|
||||
"memory_process_bytes":1175138304,
|
||||
"client_name":"lighthouse",
|
||||
"client_version":"1.1.3",
|
||||
"client_build":42,
|
||||
"sync_eth2_fallback_configured":false,
|
||||
"sync_eth2_fallback_connected":false,
|
||||
"validator_active":1,
|
||||
"validator_total":1
|
||||
},
|
||||
{
|
||||
"version":1,
|
||||
"timestamp":1618835497258,
|
||||
"process":"system",
|
||||
"cpu_cores":4,
|
||||
"cpu_threads":8,
|
||||
"cpu_node_system_seconds_total":1953818,
|
||||
"cpu_node_user_seconds_total":229215,
|
||||
"cpu_node_iowait_seconds_total":3761,
|
||||
"cpu_node_idle_seconds_total":1688619,
|
||||
"memory_node_bytes_total":33237434368,
|
||||
"memory_node_bytes_free":500150272,
|
||||
"memory_node_bytes_cached":13904945152,
|
||||
"memory_node_bytes_buffers":517832704,
|
||||
"disk_node_bytes_total":250436972544,
|
||||
"disk_node_bytes_free":124707479552,
|
||||
"disk_node_io_seconds":0,
|
||||
"disk_node_reads_total":3362272,
|
||||
"disk_node_writes_total":47766864,
|
||||
"network_node_bytes_total_receive":26546324572,
|
||||
"network_node_bytes_total_transmit":12057786467,
|
||||
"misc_node_boot_ts_seconds":1617707420,
|
||||
"misc_os":"unk"
|
||||
}
|
||||
]
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user