Skip to content

Latest commit

 

History

History
515 lines (277 loc) · 10.7 KB

metrics.rst

File metadata and controls

515 lines (277 loc) · 10.7 KB
Raw

Metrics

Nethermind metrics can be consumed by Prometheus/Grafana if configured in Metrics configuration category (check configuration documentation for details). Metrics then can be used to monitor running nodes.

Metrics infrastracture

Metrics can be enabled by simply passing --Metrics.Enabled true argument to the Nethermind.Runner or Nethermind.Launcher e.g. ./Nethermind.Runner --Metrics.Enabled true. Metrics.PushGatewayUrl will need to be amended if pushgateway endpoint is not default.

Setting up Prometheus and Pushgateway

Prometheus GitHub https://github.com/prometheus/prometheus.

Pushgateway GitHub https://github.com/prometheus/pushgateway.

  1. Basic configuration for Prometheus:

Create prometheus directory and save below file

prometheus.yml:

global:
  scrape_interval:     5s
  evaluation_interval: 5s

scrape_configs:
  - job_name: 'pushgateway'
    honor_labels: true
    static_configs:
    - targets: ['localhost:9091']
  1. Create docker-compose file outside prometheus directory

Example of docker-compose file running both Prometheus and Pushgateway:

docker-compose.yml:

version: "3.5"

services:

    prometheus:
        image: prom/prometheus
        container_name: prometheus
        volumes:
            - ./prometheus/:/etc/prometheus/
            - prometheus_data:/prometheus
        command:
            - '--config.file=/etc/prometheus/prometheus.yml'
            - '--storage.tsdb.path=/prometheus'
            - '--web.console.libraries=/etc/prometheus/console_libraries'
            - '--web.console.templates=/etc/prometheus/consoles'
            - '--storage.tsdb.retention=200h'
            - '--web.enable-lifecycle'
        restart: unless-stopped
        expose:
            - 9090
        ports: 
            - "127.0.0.1:9090:9090"
        networks:
            - metrics


    pushgateway:
        image: prom/pushgateway
        container_name: pushgateway
        restart: unless-stopped
        expose:
            - 9091
        ports:
            - "9091:9091"
        networks:
            - metrics

networks:
    metrics:
        driver: bridge

volumes:
    prometheus_data: {}
  1. Run docker-compose up

Prometheus instance should be now running on http://localhost:9090/.

Pushgateway on http://localhost:9091/.

  1. Run the Nethermind node with Metrics enabled and you should see metrics inflowing

image

  1. You can now use this data and create some awesome dashboards in your favourite data visualization tool e.g. Grafana, Splunk etc.

Blockchain

nethermind_blocks

Total number of blocks processed

nethermind_mgas

Total MGas processed

nethermind_pending_transactions_discarded

Number of pending transactions received that were ignored.

nethermind_pending_transactions_known

Number of known pending transactions.

nethermind_pending_transactions_received

Number of pending transactions received from peers.

nethermind_pending_transactions_sent

Number of pending transactions broadcasted to peers.

nethermind_processing_queue_size

Number of blocks awaiting for processing.

nethermind_recovery_queue_size

Number of blocks awaiting for recovery of public keys from signatures.

nethermind_reorganizations

Total number of chain reorganizations

nethermind_sync_peers

Number of sync peers.

nethermind_transactions

Total number of transactions processed

Evm

nethermind_blockhash_opcode

Number of BLOCKHASH opcodes executed.

nethermind_bn128add_precompile

Number of BN128_ADD precompile calls.

nethermind_bn128mul_precompile

Number of BN128_MUL precompile calls.

nethermind_bn128pairing_precompile

Number of BN128_PAIRING precompile calls.

nethermind_calls

Number of calls to other contracts.

nethermind_ec_recover_precompile

Number of EC_RECOVERY precompile calls.

nethermind_evm_exceptions

Number of EVM exceptions thrown by contracts.

nethermind_mod_exp_opcode

Number of MODEXP precompiles executed.

nethermind_mod_exp_precompile

Number of MODEXP precompile calls.

nethermind_ripemd160precompile

Number of RIPEMD160 precompile calls.

nethermind_self_destructs

Number of SELFDESTRUCT calls.

nethermind_sha256precompile

Number of SHA256 precompile calls.

nethermind_sload_opcode

Number of SLOAD opcodes executed.

nethermind_sstore_opcode

Number of SSTORE opcodes executed.

JsonRpc

nethermind_json_rpc_errors

Number of JSON RPC requests processed with errors.

nethermind_json_rpc_invalid_requests

Number of JSON RPC requests that were invalid.

nethermind_json_rpc_request_deserialization_failures

Number of JSON RPC requests that failed JSON deserialization.

nethermind_json_rpc_requests

Total number of JSON RPC requests received by the node.

nethermind_json_rpc_successes

Number of JSON RPC requests processed succesfully.

Network

nethermind_already_connected_disconnects

Number of received disconnects due to already connected

nethermind_breach_of_protocol_disconnects

Number of received disconnects due to breach of protocol

nethermind_client_quitting_disconnects

Number of received disconnects due to client quitting

nethermind_disconnect_requested_disconnects

Number of received disconnects due to disconnect requested

nethermind_eth62block_bodies_received

Number of eth.62 BlockBodies messages received

nethermind_eth62block_headers_received

Number of eth.62 BlockHeaders messages received

nethermind_eth62get_block_bodies_received

Number of eth.62 GetBlockBodies messages received

nethermind_eth62get_block_headers_received

Number of eth.62 GetBlockHeaders messages received

nethermind_eth62new_block_hashes_received

Number of eth.62 NewBlockHashes messages received

nethermind_eth62new_block_received

Number of eth.62 NewBlock messages received

nethermind_eth62transactions_received

Number of eth.62 Transactions messages received

nethermind_eth63get_node_data_received

Number of eth.63 GetNodeData messages received

nethermind_eth63get_receipts_received

Number of eth.63 GetReceipts messages received

nethermind_eth63node_data_received

Number of eth.63 NodeData messages received

nethermind_eth63receipts_received

Number of eth.63 Receipts messages received

nethermind_handshakes

Number of devp2p handshakes

nethermind_handshake_timeouts

Number of devp2p handshke timeouts

nethermind_hellos_received

Number of devp2p hello messages received

nethermind_hellos_sent

Number of devp2p hello messages sent

nethermind_incoming_connections

Number of incoming connection.

nethermind_incompatible_p2pdisconnects

Number of received disconnects due to incompatible devp2p version

nethermind_local_already_connected_disconnects

Number of initiated disconnects due to already connected

nethermind_local_breach_of_protocol_disconnects

Number of sent disconnects due to breach of protocol

nethermind_local_client_quitting_disconnects

Number of initiated disconnects due to client quitting

nethermind_local_disconnect_requested_disconnects

Number of initiated disconnects due to disconnect requested

nethermind_local_incompatible_p2pdisconnects

Number of initiated disconnects due to incompatible devp2p

nethermind_local_null_node_identity_disconnects

Number of initiated disconnects due to missing node identity

nethermind_local_other_disconnects

Number of initiated disconnects due to other reason

nethermind_local_receive_message_timeout_disconnects

Number of initiated disconnects due to request timeout

nethermind_local_same_as_self_disconnects

Number of initiated disconnects due to connection to self

nethermind_local_tcp_subsystem_error_disconnects

Number of initiated disconnects due to TCP error

nethermind_local_too_many_peers_disconnects

Number of initiated disconnects due to breach of protocol

nethermind_local_unexpected_identity_disconnects

Number of initiated disconnects due to node identity info mismatch

nethermind_local_useless_peer_disconnects

Number of sent disconnects due to useless peer

nethermind_null_node_identity_disconnects

Number of received disconnects due to missing peer identity

nethermind_other_disconnects

Number of received disconnects due to other reasons

nethermind_outgoing_connections

Number of outgoing connection.

nethermind_receive_message_timeout_disconnects

Number of received disconnects due to request timeouts

nethermind_same_as_self_disconnects

Number of received disconnects due to connecting to self

nethermind_statuses_received

Number of eth status messages received

nethermind_statuses_sent

Number of eth status messages sent

nethermind_tcp_subsystem_error_disconnects

Number of disconnects due to TCP error

nethermind_too_many_peers_disconnects

Number of received disconnects due to too many peers

nethermind_unexpected_identity_disconnects

Number of received disconnects due to peer identity information mismatch

nethermind_useless_peer_disconnects

Number of received disconnects due to useless peer

Store

nethermind_block_infos_db_reads

Number of Block Infos DB reads.

nethermind_block_infos_db_writes

Number of Block Infos DB writes.

nethermind_blocks_db_reads

Number of Blocks DB reads.

nethermind_blocks_db_writes

Number of Blocks DB writes.

nethermind_code_db_reads

Number of Code DB reads.

nethermind_code_db_writes

Number of Code DB writes.

nethermind_eth_requests_db_reads

Number of Eth Request (faucet) DB reads.

nethermind_eth_requests_db_writes

Number of Eth Request (faucet) DB writes.

nethermind_header_db_reads

Number of Headers DB reads.

nethermind_header_db_writes

Number of Headers DB writes.

nethermind_other_db_reads

Number of other DB reads.

nethermind_other_db_writes

Number of other DB writes.

nethermind_pending_txs_db_reads

Number of Pending Tx DB reads.

nethermind_pending_txs_db_writes

Number of Pending Tx DB writes.

nethermind_receipts_db_reads

Number of Receipts DB reads.

nethermind_receipts_db_writes

Number of Receipts DB writes.

nethermind_state_db_reads

Number of State DB reads.

nethermind_state_db_writes

Number of State DB writes.

nethermind_state_tree_reads

Number of State Trie reads.

nethermind_state_tree_writes

Number of Blocks Trie writes.

nethermind_storage_tree_reads

Number of storge trie reads.

nethermind_storage_tree_writes

Number of storage trie writes.

nethermind_tree_node_hash_calculations

Number of trie node hash calculations.

nethermind_tree_node_rlp_decodings

Number of trie node RLP decodings.

nethermind_tree_node_rlp_encodings

Number of trie node RLP encodings.