github.com/prysmaticlabs/prysm@v1.4.4/shared/clientstats/README.md (about) 1 # Client stats reporting 2 3 ## Specification 4 5 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. 6 7 8 |Property |Type |Process |Source |Description | 9 |-----------------------------------|-------------|---------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 10 |version |int |Every request |hard-coded |Stats data specification version, current only `1` is accepted | 11 |timestamp |long |Every request |system time |Unix timestamp in milliseconds | 12 |process |string (enum)|Every request |hard-coded / cli flag |Enum values: validator, beaconnode, system | 13 |cpu_process_seconds_total |long |beaconnode, validator|prom: process_cpu_seconds_total |CPU seconds consumed by the process | 14 |memory_process_bytes |long |beaconnode, validator|prom: process_resident_memory_bytes |Number of bytes allocated to the process | 15 |client_name |string |beaconnode, validator|hard-coded to "prysm" |Name of the client type. Ex: prysm, lighthouse, nimbus, teku | 16 |client_version |string |beaconnode, validator|prom: prysm_version (label: version) |Client version. Ex: 1.0.0-beta.0 | 17 |client_build |int |beaconnode, validator|prom: prysm_version (label: buildDate) |Integer representation of build for easier comparison | 18 |disk_beaconchain_bytes_total |long |beaconchain |prom: bcnode_disk_beaconchain_bytes_total |The amount of data consumed on disk by the beacon chain's database. | 19 |network_libp2p_bytes_total_receive |long |beaconchain |(currently unsupported) |The number of bytes received via libp2p traffic | 20 |network_libp2p_bytes_total_transmit|long |beaconchain |(currently unsupported) |The number of bytes transmitted via libp2p traffic | 21 |network_peers_connected |int |beaconchain |(currently unsupported) |The number of peers currently connected to the beacon chain | 22 |sync_eth1_connected |bool |beaconchain |prom: powchain_sync_eth1_connected |Whether or not the beacon chain node is connected to a _synced_ eth1 node | 23 |sync_eth2_synced |bool |beaconchain |prom: beacon_clock_time_slot (true if this equals prom: beacon_head_slot)|Whether or not the beacon chain node is in sync with the beacon chain network | 24 |sync_beacon_head_slot |long |beaconchain |prom: beacon_head_slot |The head slot number. | 25 |sync_eth1_fallback_configured |bool |beaconchain |prom: powchain_sync_eth1_fallback_configured |Whether or not the beacon chain node has a fallback eth1 endpoint configured. | 26 |sync_eth1_fallback_connected |bool |beaconchain |prom: powchain_sync_eth1_fallback_connected |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.| 27 |slasher_active |bool |beaconchain |(coming soon) |Whether or not slasher functionality is enabled. | 28 |sync_eth2_fallback_configured |bool |validator |(currently unsupported) |Whether or not the process has a fallback eth2 endpoint configured | 29 |sync_eth2_fallback_connected |bool |validator |(currently unsupported) |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. | 30 |validator_total |int |validator |prom: validator_statuses (count of all peers) |The number of validating keys in use. | 31 |validator_active |int |validator |prom: validator_statuses (count of peers w/ "ACTIVE" status label) |The number of validator keys that are currently active. | 32 |cpu_cores |int |system |(currently unsupported) |The number of CPU cores available on the host machine | 33 |cpu_threads |int |system |(currently unsupported) |The number of CPU threads available on the host machine | 34 |cpu_node_system_seconds_total |long |system |(currently unsupported) |Overall CPU seconds observed on the host machine for all processes. | 35 |cpu_node_user_seconds_total |long |system |(currently unsupported) |?? | 36 |cpu_node_iowait_seconds_total |long |system |(currently unsupported) |?? | 37 |cpu_node_idle_seconds_total |long |system |(currently unsupported) |?? | 38 |memory_node_bytes_total |long |system |(currently unsupported) |?? | 39 |memory_node_bytes_free |long |system |(currently unsupported) |?? | 40 |memory_node_bytes_cached |long |system |(currently unsupported) |?? | 41 |memory_node_bytes_bufferd |long |system |(currently unsupported) |?? | 42 |disk_node_bytes_total |long |system |(currently unsupported) |?? | 43 |disk_node_bytes_free |long |system |(currently unsupported) |?? | 44 |disk_node_io_seconds |long |system |(currently unsupported) |?? | 45 |disk_node_reads_total |long |system |(currently unsupported) |?? | 46 |disk_node_writes_total |long |system |(currently unsupported) |?? | 47 |network_node_bytes_total_receive |long |system |(currently unsupported) |?? | 48 |network_node_bytes_total_transmit |long |system |(currently unsupported) |?? | 49 |misc_node_boot_ts_system |long |system |(currently unsupported) |?? | 50 |misc_os |string |system |(currently unsupported) |Enum values: lin, win, mac, unk | 51 52 The client stats reporter will submit a request object for each process type. The report request may 53 submit a list of data or a single JSON object. 54 55 ### Examples 56 57 POST https://beaconcha.in/api/v1/stats/$API_KEY/$MACHINE_NAME 58 59 **Single object payload** 60 61 ```json 62 { 63 "version": 1, 64 "timestamp": 11234567, 65 "process": "validator", 66 "cpu_process_seconds_total": 1234567, 67 "memory_process_bytes": 654321, 68 "client_name": "lighthouse", 69 "client_version": "1.1.2", 70 "client_build": 12, 71 "sync_eth2_fallback_configured": false, 72 "sync_eth2_fallback_connected": false, 73 "validator_total": 3, 74 "validator_active": 2 75 } 76 ``` 77 78 **Multiple object payload** 79 80 ```json 81 [ 82 { 83 "version":1, 84 "timestamp":1618835497239, 85 "process":"beaconnode", 86 "cpu_process_seconds_total":6925, 87 "memory_process_bytes":1175138304, 88 "client_name":"lighthouse", 89 "client_version":"1.1.3", 90 "client_build":42, 91 "sync_eth2_fallback_configured":false, 92 "sync_eth2_fallback_connected":false, 93 "validator_active":1, 94 "validator_total":1 95 }, 96 { 97 "version":1, 98 "timestamp":1618835497258, 99 "process":"system", 100 "cpu_cores":4, 101 "cpu_threads":8, 102 "cpu_node_system_seconds_total":1953818, 103 "cpu_node_user_seconds_total":229215, 104 "cpu_node_iowait_seconds_total":3761, 105 "cpu_node_idle_seconds_total":1688619, 106 "memory_node_bytes_total":33237434368, 107 "memory_node_bytes_free":500150272, 108 "memory_node_bytes_cached":13904945152, 109 "memory_node_bytes_buffers":517832704, 110 "disk_node_bytes_total":250436972544, 111 "disk_node_bytes_free":124707479552, 112 "disk_node_io_seconds":0, 113 "disk_node_reads_total":3362272, 114 "disk_node_writes_total":47766864, 115 "network_node_bytes_total_receive":26546324572, 116 "network_node_bytes_total_transmit":12057786467, 117 "misc_node_boot_ts_seconds":1617707420, 118 "misc_os":"unk" 119 } 120 ] 121 ```