From ba210af0944914a630399125974d31fa42c9c76a Mon Sep 17 00:00:00 2001 From: J_ATEAM Date: Mon, 6 Jan 2020 16:23:41 +0900 Subject: [PATCH] Update README.md --- README.md | 101 ------------------------------------------------------ 1 file changed, 101 deletions(-) diff --git a/README.md b/README.md index a9ed64e..0c24425 100644 --- a/README.md +++ b/README.md @@ -10,104 +10,3 @@ Prometheus exporter for Cosmos Validators This exporter is for monitoring information which is not provided from Tendermint’s basic Prometheus exporter (localhost:26660), and other specific information monitoring purposes -## Collecting information list -> **Network** -- chainId: Name of the chain -- blockHeight: Height of the current block -- currentBlockTime: Time it takes to create & confirm block (current block time - previous block time) -- bondedTokens: Number of currently bonded Atom -- notBondedTokens: Number of unbonded Atom -- totalBondedTokens: Number of currently bonded & unbonded Atom -- bondedRate: Ratio of bonded tokens within the network -- blockPerYear: Number of blocks generated in one year -- defaultBlockTime: Preset (default) block time -- defaultBlockTimeInflation: Inflation rate based on defaultBlockTime -- currentBlockTimeInflation: Inflation rate based on current block time -- inflationMax: Maximum Inflation -- inflationMin: Minimum Inflation -- inflationRateChange: Total range which the inflation can change -- inflationGoalBonded: Target bonding rate which changes the velocity of the inflation -- validatorCount: Number of validators within the network -- precommitRate: Precommit Ratio of precommits collected in a round -- proposerWalletAccountNumber: Account number given on each validator’s wallet (Required to show Proposer in Grafana) - -> **Validator Info** -- moniker: Name of the validator -- accountAddress: Validator's Account address -- consHexAddress: Validator's Consensus Hex address -- operatorAddress: Validator's Operator address -- validatorPubKey: Validator's Validator pubkey(```gaiad tendermint show-validator```) -- votingPower: Decimal truncated Total voting power of the validator -- delegatorShares: Validator's total delegated tokens -- delegatorCount: Number of each unique delegators for a validator -- delegationRatio: Ratio of validator's bonded tokens to the network's total bonded tokens -- selfDelegationAmount: Self-bonded amount of the validator -- proposerPriorityValue: Number which represents the priority of the validator proposing in the next round -- proposerPriority: Rank of the proposerPriorityValue -- proposingStatus: Shows if the validator is the proposer or not in the current round(true: 1, false: 0) -- validatorCommitStatus: Confirms if the validator has committed in this round(true: 1, false: 0) -- commissionMaxChangeRate: Max range of commission rate whic hthe validator can change -- commissionMaxRate: The highest commission rate which the validator can charge -- commissionRate: Commission rate of the validator charged on delegators' rewards -- balances(uatom): Wallet information of the validator which shows the balance -- commission(uatom): Accumulated commission fee of the validator -- rewards(uatom): Accumulated rewards of the validator -- minSelfDelegation(Atom): The required minimum number of tokens which the validator must self-delegate -- jailed: Confirms if the validator is jailed or not(true: 1, false: 0) - -![CreatePlan](./example/monitoring_example(prometheus).png) - - -## Quick Start -RPC and REST server information is required to run the program -- Download -``` -wget https://github.com/node-a-team/cosmos-validator_exporter/releases/download/v0.1.0/cosmos-validator_exporter_v0.1.0.tar.gz -tar -xzvf cosmos-validator_exporter_v0.1.0.tar.gz && cd cosmos-validator_exporter -``` - - - Config Setup - 1) Input RPC and Rest server information - 2) Input validator operator address(```gaiacli keys show [Key Name] --bech=val --address```) - 3) Set exporter port - 4) Set outPrint (if true: prints collected information from the exporter) -``` -vi config.toml -``` -``` -# TOML Document for Cosmos-Validator Exporter(Pometheus & Grafana) - -title = "Cosmos-Validator Exporter TOML" -network = "cosmos" - -# RPC-Server -[rpc] -address = "localhost:26657" - -[rest_server] -address = "localhost:1317" - -[validator_info] -operatorAddress = "cosmosvaloper14l0fp639yudfl46zauvv8rkzjgd4u0zk2aseys" - -[option] -exporterListenPort = "26661" -outputPrint = true -``` - -![CreatePlan](./example/config.png) - - - Run -``` -./cosmos-validator_exporter -``` - -![CreatePlan](./example/config_outputPrint(true).png) - - -## Grafana Example - - template: https://grafana.com/grafana/dashboards/10942/revisions - -Can set alarms using the functions on Grafana (ex. Alarms if the validator fails to precommit or gets jailed) -![CreatePlan](./example/monitoring_example(grafana).png) -