chain-state-exporter

README

Chain State Exporter

Chain State Exporter collects the state of Darwinia Network and exposes them in Prometheus compatible metrics formats.

Currently, it works with Darwinia CC1 and Darwinia Crab.

Releases

Until v1 released, chain-state-exporter is still under development, any API or CLI options may be changed in future versions.

The releases are under GitHub's release page. You can pull the image by using one of the versions, for example:

docker pull quay.io/darwinia-network/chain-state-exporter:v0.1.0

Usage

1. Download custom types definition file:

   wget -O types.json https://raw.githubusercontent.com/darwinia-network/chain-state-exporter/master/types.json
   

2. Run the exporter with types.json and the official Darwinia RPC node (wss://cc1.darwinia.network):

   docker run -d \
       -p 9602:9602 \
       -v $PWD/types.json:/types.json \
       quay.io/darwinia-network/chain-state-exporter:v0.1.0 \
           --ws-endpoint wss://cc1.darwinia.network
   

   9602 is the default port of chain-state-exporter. Don't forget to check out the latest release instead of using the version v0.1.0 which might be stale already.

3. Test the exporter with curl command:

   curl localhost:9602/metrics
   

   Example results:

   # HELP darwinia_state_active_era_index
   # TYPE darwinia_state_active_era_index counter
   darwinia_state_active_era_index 97
   
   ...
   
   # HELP darwinia_state_validators_total
   # TYPE darwinia_state_validators_total gauge
   darwinia_state_validators_total 69
   

4. Example Prometheus config with static target:

scrape_configs:
  - job_name:
    static_configs:
      - targets:
          - 127.0.0.1:9162

Metrics Reference

New metrics proposals are always welcome, please feel free to submit an issue.

Meta Metrics

Metric Name	Description
last_scrape_error	Whether the last scrape of metrics resulted in an error (1 for error, 0 for success)
last_scrape_duration_seconds	Time duration of last scrape in seconds

Storage Metrics

Metric Name	Source (Chain Storage Name)	Description
active_era_index	staking.activeEra
session_index	session.currentIndex
validators_total	session.validators	Size of current validators set
era_reward_points	staking.erasRewardPoints	Label account_id is the public key of corresponding validator, label address is the SS58 address on Darwinia network
pending_headers_total	ethereumRelay.pendingRelayHeaderParcels	Number of pending Ethereum header parcels

License

MIT