Skip to main content
Version: Next



Gather relevant insights about your application and modules with custom metrics and telemetry.

The Cosmos SDK enables operators and developers to gain insight into the performance and behavior of their application through the use of the telemetry package. To enable telemetrics, set telemetry.enabled = true in the app.toml config file.

The Cosmos SDK currently supports enabling in-memory and prometheus as telemetry sinks. In-memory sink is always attached (when the telemetry is enabled) with 10 second interval and 1 minute retention. This means that metrics will be aggregated over 10 seconds, and metrics will be kept alive for 1 minute.

To query active metrics (see retention note above) you have to enable API server (api.enabled = true in the app.toml). Single API endpoint is exposed: http://localhost:1317/metrics?format={text|prometheus}, the default being text.

Emitting metrics

If telemetry is enabled via configuration, a single global metrics collector is registered via the go-metrics library. This allows emitting and collecting metrics through simple API. Example:

func EndBlocker(ctx sdk.Context, k keeper.Keeper) {
defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyEndBlocker)

// ...

Developers may use the telemetry package directly, which provides wrappers around metric APIs that include adding useful labels, or they must use the go-metrics library directly. It is preferable to add as much context and adequate dimensionality to metrics as possible, so the telemetry package is advised. Regardless of the package or method used, the Cosmos SDK supports the following metrics types:

  • gauges
  • summaries
  • counters


Certain components of modules will have their name automatically added as a label (e.g. BeginBlock). Operators may also supply the application with a global set of labels that will be applied to all metrics emitted using the telemetry package (e.g. chain-id). Global labels are supplied as a list of [name, value] tuples.


global-labels = [
["chain_id", "chain-OfXo4V"],


Cardinality is key, specifically label and key cardinality. Cardinality is how many unique values of something there are. So there is naturally a tradeoff between granularity and how much stress is put on the telemetry sink in terms of indexing, scrape, and query performance.

Developers should take care to support metrics with enough dimensionality and granularity to be useful, but not increase the cardinality beyond the sink's limits. A general rule of thumb is to not exceed a cardinality of 10.

Consider the following examples with enough granularity and adequate cardinality:

  • begin/end blocker time
  • tx gas used
  • block gas used
  • amount of tokens minted
  • amount of accounts created

The following examples expose too much cardinality and may not even prove to be useful:

  • transfers between accounts with amount
  • voting/deposit amount from unique addresses

Supported Metrics

tx_countTotal number of txs processed via DeliverTxtxcounter
tx_successfulTotal number of successful txs processed via DeliverTxtxcounter
tx_failedTotal number of failed txs processed via DeliverTxtxcounter
tx_gas_usedThe total amount of gas used by a txgasgauge
tx_gas_wantedThe total amount of gas requested by a txgasgauge
tx_msg_sendThe total amount of tokens sent in a MsgSend (per denom)tokengauge
tx_msg_withdraw_rewardThe total amount of tokens withdrawn in a MsgWithdrawDelegatorReward (per denom)tokengauge
tx_msg_withdraw_commissionThe total amount of tokens withdrawn in a MsgWithdrawValidatorCommission (per denom)tokengauge
tx_msg_delegateThe total amount of tokens delegated in a MsgDelegatetokengauge
tx_msg_begin_unbondingThe total amount of tokens undelegated in a MsgUndelegatetokengauge
tx_msg_begin_begin_redelegateThe total amount of tokens redelegated in a MsgBeginRedelegatetokengauge
tx_msg_ibc_transferThe total amount of tokens transferred via IBC in a MsgTransfer (source or sink chain)tokengauge
ibc_transfer_packet_receiveThe total amount of tokens received in a FungibleTokenPacketData (source or sink chain)tokengauge
new_accountTotal number of new accounts createdaccountcounter
gov_proposalTotal number of governance proposalsproposalcounter
gov_voteTotal number of governance votes for a proposalvotecounter
gov_depositTotal number of governance deposits for a proposaldepositcounter
staking_delegateTotal number of delegationsdelegationcounter
staking_undelegateTotal number of undelegationsundelegationcounter
staking_redelegateTotal number of redelegationsredelegationcounter
ibc_transfer_sendTotal number of IBC transfers sent from a chain (source or sink)transfercounter
ibc_transfer_receiveTotal number of IBC transfers received to a chain (source or sink)transfercounter
ibc_client_createTotal number of clients createdcreatecounter
ibc_client_updateTotal number of client updatesupdatecounter
ibc_client_upgradeTotal number of client upgradesupgradecounter
ibc_client_misbehaviourTotal number of client misbehavioursmisbehaviourcounter
ibc_connection_open-initTotal number of connection OpenInit handshakeshandshakecounter
ibc_connection_open-tryTotal number of connection OpenTry handshakeshandshakecounter
ibc_connection_open-ackTotal number of connection OpenAck handshakeshandshakecounter
ibc_connection_open-confirmTotal number of connection OpenConfirm handshakeshandshakecounter
ibc_channel_open-initTotal number of channel OpenInit handshakeshandshakecounter
ibc_channel_open-tryTotal number of channel OpenTry handshakeshandshakecounter
ibc_channel_open-ackTotal number of channel OpenAck handshakeshandshakecounter
ibc_channel_open-confirmTotal number of channel OpenConfirm handshakeshandshakecounter
ibc_channel_close-initTotal number of channel CloseInit handshakeshandshakecounter
ibc_channel_close-confirmTotal number of channel CloseConfirm handshakeshandshakecounter
tx_msg_ibc_recv_packetTotal number of IBC packets receivedpacketcounter
tx_msg_ibc_acknowledge_packetTotal number of IBC packets acknowledgedacknowledgementcounter
ibc_timeout_packetTotal number of IBC timeout packetstimeoutcounter
store_iavl_getDuration of an IAVL Store#Get callmssummary
store_iavl_setDuration of an IAVL Store#Set callmssummary
store_iavl_hasDuration of an IAVL Store#Has callmssummary
store_iavl_deleteDuration of an IAVL Store#Delete callmssummary
store_iavl_commitDuration of an IAVL Store#Commit callmssummary
store_iavl_queryDuration of an IAVL Store#Query callmssummary