analytics(app): add telemetry to Evmos modules

[danburck]

Description

This PR adds telemetry to Evmos to analyze the performance of the modules. A guide on telemetry in the Cosmos SDK can be found here. By generating this data we can understand how Evmos is being used, e.g. we can observe how many users interact with incentivized contracts and how many tokens were distributed in total through incentives.

Metrics

I implemented the following metrics to observe and added them to the specs:

Metric	Description	Unit	Type
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 etheruem tx	token	counter
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_participant_total	Total number of participants who received rewards	participant	counter
incentives_distribute_reward_total	Total amount of rewards that are distributed to all incentives' participants	token	counter
inflation_hook_allocate_total	Total amount of tokens allocated through inflation	token	counter
inflation_hook_allocate_staking_total	Total amount of tokens allocated through inflation to staking	token	counter
inflation_hook_allocate_incentives_total	Total amount of tokens allocated through inflation to incentives	token	counter
inflation_hook_allocate_community_pool_total	Total amount of tokens allocated through inflation to community pool	token	counter
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

Notes

Reference used for naming endpoints: https://blog.pvincent.io/2017/12/prometheus-blog-series-part-2-metric-types/

Please also note that some endpoints are implemented in ethermint

[linear]

ENG-382 Add Observability (telemetry) on Evmos

similar to https://linear.app/evmos/issue/ENG-381/observability-telemetry-on-ethermint-reimplement

[codecov]

Codecov Report

Merging #637 (49c0c39) into main (3be5018) will decrease coverage by 0.08%.
The diff coverage is 80.95%.

❗ Current head 49c0c39 differs from pull request most recent head 68b69a4. Consider uploading reports for the commit 68b69a4 to get more accurate results

@@            Coverage Diff             @@
##             main     #637      +/-   ##
==========================================
- Coverage   82.61%   82.53%   -0.09%     
==========================================
  Files         122      122              
  Lines        6725     6870     +145     
==========================================
+ Hits         5556     5670     +114     
- Misses       1029     1055      +26     
- Partials      140      145       +5     

Impacted Files	Coverage Δ
app/app.go	84.81% <ø> (ø)
x/incentives/keeper/epoch_hooks.go	73.68% <0.00%> (ø)
x/inflation/keeper/hooks.go	68.93% <9.37%> (-25.59%)	⬇️
x/inflation/keeper/inflation.go	79.78% <71.42%> (-2.44%)	⬇️
x/incentives/keeper/distribution.go	78.57% <94.11%> (+3.39%)	⬆️
x/erc20/keeper/msg_server.go	98.28% <100.00%> (+0.36%)	⬆️
x/incentives/keeper/evm_hooks.go	87.75% <100.00%> (+3.97%)	⬆️
x/recovery/keeper/ibc_callbacks.go	96.07% <100.00%> (+0.31%)	⬆️

[Prosp3r]

I've become very eagle-eyed due to constantly looking and the linter errors.
I think we could either refactor as we improve on each module or enter improvements and let the Linter do its work when implemented so we can then add all warnings to the sub issues in ENG-284

[fedekunze]

based on our conversation

• erc20 module:
  • total number of transactions (counter with labels for denom and erc20 contract)
  • total amount converted (counter with labels for denom and erc20 contract)
• on inflation, we care about
  • the total amount of tokens minted (not epoch count)
• for incentives, we need to track the
  • total amount of rewards allocated per contract (counter with label)
  • total number of participants (labeled per contract)
  • number of rewards allocated per participant (eg: to track bots)
• recovery: also add the amount of tokens recovered (counter)
• fees:
  • total amount fees allocated to devs/contract deployers (label by contract) and validators (no label since it's allocated to the fee collector Module Account)

[danburck]

@fedekunze

• number of rewards allocated per participant (eg: to track bots)

This would have to be implemented here

I'm considering if this will be to nested, what do you think?

[fedekunze]

LGTM, Minor comments.

changes requested are not relevant in this PR

[Prosp3r]

LGTM