Skip to content

Commit

Permalink
chore: update metrics (#123)
Browse files Browse the repository at this point in the history
  • Loading branch information
GAtom22 authored Oct 11, 2023
1 parent 82458c7 commit e78ee9e
Showing 1 changed file with 29 additions and 21 deletions.
50 changes: 29 additions & 21 deletions docs/protocol/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 6

# Metrics

Evmos nodes can enable [Cosmos SDK telemetry](https://docs.cosmos.network/main/core/telemetry.html)
Evmos nodes can enable [Cosmos SDK telemetry](https://docs.cosmos.network/main/learn/advanced/telemetry)
to allow for observing and gathering insights about the Evmos application.
Under the hood, it uses the [`go-metrics`](https://github.com/hashicorp/go-metrics) package
and the Prometheus client library to expose different [types of metrics](https://prometheus.io/docs/concepts/metric_types/)
Expand All @@ -18,23 +18,31 @@ and display them in a [Grafana](https://grafana.com/) dashboard.

## Supported Metrics

| Metric | Description | Unit | Type |
| :--------------------------------------------- | :---------------------------------------------------------------------------------- | :---------- | :------ |
| `feemarket_base_fee` | Amount of base fee per EIP-1559 block | token | gauge |
| `feemarket_block_gas` | Amount of gas used in an EIP-1559 block | token | gauge |
| `recovery_ibc_on_recv_total` | Total number of recoveries using the ibc `onRecvPacket` callback | recovery | counter |
| `recovery_ibc_on_recv_token_total` | Total amount of tokens recovered using the ibc `onRecvPacket` callback | token | counter |
| `tx_msg_convert_coin_amount_total` | Total amount of converted coins using a `ConvertCoin` msg | token | counter |
| `tx_msg_convert_coin_total` | Total number of txs with a `ConvertCoin` msg | tx | counter |
| `tx_msg_convert_erc20_amount_total` | Total amount of converted erc20 using a `ConvertERC20` msg | token | counter |
| `tx_msg_convert_erc20_total` | Total number of txs with a `ConvertERC20` msg | tx | counter |
| `tx_msg_ethereum_tx_total` | Total number of txs processed via the EVM | tx | counter |
| `tx_msg_ethereum_tx_gas_used_total` | Total amount of gas used by an ethereum tx | token | counter |
| `tx_msg_ethereum_tx_gas_limit_per_gas_used` | Ratio of gas limit to gas used for an ethereum tx | ratio | gauge |
| `tx_msg_ethereum_tx_incentives_total` | Total number of txs with an incentivized contract processed via the EVM | tx | counter |
| `tx_msg_ethereum_tx_incentives_gas_used_total` | Total amount of gas used by txs with an incentivized contract processed via the EVM | token | counter |
| `incentives_distribute_reward_total` | Total amount of rewards that are distributed to all incentives' participants | token | counter |
| `inflation_allocate_total` | Total amount of tokens allocated through inflation | token | counter |
| `inflation_allocate_staking_total` | Total amount of tokens allocated through inflation to staking | token | counter |
| `inflation_allocate_incentives_total` | Total amount of tokens allocated through inflation to incentives | token | counter |
| `inflation_allocate_community_pool_total` | Total amount of tokens allocated through inflation to community pool | token | counter |
| Metric | Description | Unit | Type |
| :--------------------------------------------- | :----------------------------------------------------------------------------------------------------------- | :------- | :-------- |
| `feemarket_base_fee` | Amount of base fee per EIP-1559 block | token | gauge |
| `feemarket_block_gas` | Amount of gas used in an EIP-1559 block | token | gauge |
| `recovery_ibc_on_recv_total` | Total number of recoveries using the ibc `onRecvPacket` callback | recovery | counter |
| `recovery_ibc_on_recv_token_total` | Total amount of tokens recovered using the ibc `onRecvPacket` callback | token | counter |
| `erc20_ibc_on_recv_total` | Total amount of times an IBC coin was autoconverted to an ERC20 token in the ibc `onRecvPacket` callback | transfer | counter |
| `erc20_ibc_err_total` | Total amount of times an IBC coin autoconvertion to ERC20 token failed during an ibc transaction | transfer | counter |
| `erc20_ibc_transfer_total` | Total amount of times an IBC coin or its ERC20 representation was transferred via ibc (outgoing transaction) | transfer | counter |
| `tx_msg_convert_coin_amount_total` | Total amount of converted coins using a `ConvertCoin` msg | token | counter |
| `tx_msg_convert_coin_total` | Total number of txs with a `ConvertCoin` msg | tx | counter |
| `tx_msg_convert_erc20_amount_total` | Total amount of converted erc20 using a `ConvertERC20` msg | token | counter |
| `tx_msg_convert_erc20_total` | Total number of txs with a `ConvertERC20` msg | tx | counter |
| `tx_msg_ethereum_tx_total` | Total number of txs processed via the EVM | tx | counter |
| `tx_msg_ethereum_tx_gas_used_total` | Total amount of gas used by an ethereum tx | gas | counter |
| `tx_msg_ethereum_tx_gas_limit_per_gas_used` | Ratio of gas limit to gas used for an ethereum tx | ratio | gauge |
| `tx_msg_ethereum_tx_incentives_total` | Total number of txs with an incentivized contract processed via the EVM | tx | counter |
| `tx_msg_ethereum_tx_incentives_gas_used_total` | Total amount of gas used by txs with an incentivized contract processed via the EVM | gas | counter |
| `incentives_distribute_reward_total` | Total amount of rewards that are distributed to all incentives' participants | token | counter |
| `inflation_allocate_total` | Total amount of tokens allocated through inflation | token | counter |
| `inflation_allocate_staking_total` | Total amount of tokens allocated through inflation to staking | token | counter |
| `inflation_allocate_incentives_total` | Total amount of tokens allocated through inflation to incentives | token | counter |
| `inflation_allocate_community_pool_total` | Total amount of tokens allocated through inflation to community pool | token | counter |
| `tx_create_clawback_vesting_account_gas_used` | Total amount of gas used by a `CreateClawbackVestingAccount` msg | gas | counter |
| `tx_fund_vesting_account_gas_used` | Total amount of gas used by a `FundVestingAccount` msg | gas | counter |
| `tx_clawback_gas_used` | Total amount of gas used by a `Clawback` msg | gas | counter |
| `tx_update_vesting_funder_gas_used` | Total amount of gas used by a `UpdateVestingFunder` msg | gas | counter |
| `epochs_begin_blocker` | Time spent during `BeginBlocker` of the `x/epochs` module | ms | histogram |

0 comments on commit e78ee9e

Please sign in to comment.