fix: correct ibc metric labels (#9645)

* backport cosmos/ibc-go#223

* add changelog

* fix unnecessary changes

CHANGELOG.md

@@ -43,6 +43,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Bug Fixes
 
+* [\#9645](https://github.com/cosmos/cosmos-sdk/pull/9645) Use correct Prometheus format for metric labels.
 * [\#9299](https://github.com/cosmos/cosmos-sdk/pull/9299) Fix `[appd] keys parse cosmos1...` freezing.
 
 ## [v0.42.6](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.42.6) - 2021-06-18

x/ibc/applications/transfer/keeper/relay.go

@@ -13,6 +13,7 @@ import (
 	clienttypes "github.com/cosmos/cosmos-sdk/x/ibc/core/02-client/types"
 	channeltypes "github.com/cosmos/cosmos-sdk/x/ibc/core/04-channel/types"
 	host "github.com/cosmos/cosmos-sdk/x/ibc/core/24-host"
+	coretypes "github.com/cosmos/cosmos-sdk/x/ibc/core/types"
 )
 
 // SendTransfer handles transfer sending logic. There are 2 possible cases:
@@ -101,16 +102,16 @@ func (k Keeper) SendTransfer(
 	}
 
 	labels := []metrics.Label{
-		telemetry.NewLabel("destination-port", destinationPort),
-		telemetry.NewLabel("destination-channel", destinationChannel),
+		telemetry.NewLabel(coretypes.LabelDestinationPort, destinationPort),
+		telemetry.NewLabel(coretypes.LabelDestinationChannel, destinationChannel),
 	}
 
 	// NOTE: SendTransfer simply sends the denomination as it exists on its own
 	// chain inside the packet data. The receiving chain will perform denom
 	// prefixing as necessary.
 
 	if types.SenderChainIsSource(sourcePort, sourceChannel, fullDenomPath) {
-		labels = append(labels, telemetry.NewLabel("source", "true"))
+		labels = append(labels, telemetry.NewLabel(coretypes.LabelSource, "true"))
 
 		// create the escrow address for the tokens
 		escrowAddress := types.GetEscrowAddress(sourcePort, sourceChannel)
@@ -123,7 +124,7 @@ func (k Keeper) SendTransfer(
 		}
 
 	} else {
-		labels = append(labels, telemetry.NewLabel("source", "false"))
+		labels = append(labels, telemetry.NewLabel(coretypes.LabelSource, "false"))
 
 		// transfer the coins to the module account and burn them
 		if err := k.bankKeeper.SendCoinsFromAccountToModule(
@@ -165,7 +166,7 @@ func (k Keeper) SendTransfer(
 		telemetry.SetGaugeWithLabels(
 			[]string{"tx", "msg", "ibc", "transfer"},
 			float32(token.Amount.Int64()),
-			[]metrics.Label{telemetry.NewLabel("denom", fullDenomPath)},
+			[]metrics.Label{telemetry.NewLabel(coretypes.LabelDenom, fullDenomPath)},
 		)
 
 		telemetry.IncrCounterWithLabels(
@@ -200,8 +201,8 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
 	}
 
 	labels := []metrics.Label{
-		telemetry.NewLabel("source-port", packet.GetSourcePort()),
-		telemetry.NewLabel("source-channel", packet.GetSourceChannel()),
+		telemetry.NewLabel(coretypes.LabelSourcePort, packet.GetSourcePort()),
+		telemetry.NewLabel(coretypes.LabelSourceChannel, packet.GetSourceChannel()),
 	}
 
 	// This is the prefix that would have been prefixed to the denomination
@@ -244,14 +245,14 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
 			telemetry.SetGaugeWithLabels(
 				[]string{"ibc", types.ModuleName, "packet", "receive"},
 				float32(data.Amount),
-				[]metrics.Label{telemetry.NewLabel("denom", unprefixedDenom)},
+				[]metrics.Label{telemetry.NewLabel(coretypes.LabelDenom, unprefixedDenom)},
 			)
 
 			telemetry.IncrCounterWithLabels(
 				[]string{"ibc", types.ModuleName, "receive"},
 				1,
 				append(
-					labels, telemetry.NewLabel("source", "true"),
+					labels, telemetry.NewLabel(coretypes.LabelSource, "true"),
 				),
 			)
 		}()
@@ -303,14 +304,14 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
 		telemetry.SetGaugeWithLabels(
 			[]string{"ibc", types.ModuleName, "packet", "receive"},
 			float32(data.Amount),
-			[]metrics.Label{telemetry.NewLabel("denom", data.Denom)},
+			[]metrics.Label{telemetry.NewLabel(coretypes.LabelDenom, data.Denom)},
 		)
 
 		telemetry.IncrCounterWithLabels(
 			[]string{"ibc", types.ModuleName, "receive"},
 			1,
 			append(
-				labels, telemetry.NewLabel("source", "false"),
+				labels, telemetry.NewLabel(coretypes.LabelSource, "false"),
 			),
 		)
 	}()

x/ibc/core/02-client/keeper/client.go

@@ -47,7 +47,7 @@ func (k Keeper) CreateClient(
 		telemetry.IncrCounterWithLabels(
 			[]string{"ibc", "client", "create"},
 			1,
-			[]metrics.Label{telemetry.NewLabel("client-type", clientState.ClientType())},
+			[]metrics.Label{telemetry.NewLabel(types.LabelClientType, clientState.ClientType())},
 		)
 	}()
 
@@ -90,9 +90,9 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
 			[]string{"ibc", "client", "update"},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("client-type", clientState.ClientType()),
-				telemetry.NewLabel("client-id", clientID),
-				telemetry.NewLabel("update-type", "msg"),
+				telemetry.NewLabel(types.LabelClientType, clientState.ClientType()),
+				telemetry.NewLabel(types.LabelClientID, clientID),
+				telemetry.NewLabel(types.LabelUpdateType, "msg"),
 			},
 		)
 	}()
@@ -151,8 +151,8 @@ func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient e
 			[]string{"ibc", "client", "upgrade"},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("client-type", updatedClientState.ClientType()),
-				telemetry.NewLabel("client-id", clientID),
+				telemetry.NewLabel(types.LabelClientType, updatedClientState.ClientType()),
+				telemetry.NewLabel(types.LabelClientID, clientID),
 			},
 		)
 	}()
@@ -195,8 +195,8 @@ func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour ex
 			[]string{"ibc", "client", "misbehaviour"},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("client-type", misbehaviour.ClientType()),
-				telemetry.NewLabel("client-id", misbehaviour.GetClientID()),
+				telemetry.NewLabel(types.LabelClientType, misbehaviour.ClientType()),
+				telemetry.NewLabel(types.LabelClientID, misbehaviour.GetClientID()),
 			},
 		)
 	}()

x/ibc/core/02-client/keeper/proposal.go

@@ -42,9 +42,9 @@ func (k Keeper) ClientUpdateProposal(ctx sdk.Context, p *types.ClientUpdatePropo
 			[]string{"ibc", "client", "update"},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("client-type", clientState.ClientType()),
-				telemetry.NewLabel("client-id", p.ClientId),
-				telemetry.NewLabel("update-type", "proposal"),
+				telemetry.NewLabel(types.LabelClientType, clientState.ClientType()),
+				telemetry.NewLabel(types.LabelClientID, p.ClientId),
+				telemetry.NewLabel(types.LabelUpdateType, "proposal"),
 			},
 		)
 	}()

x/ibc/core/02-client/types/metrics.go

@@ -0,0 +1,9 @@
+package types
+
+// Prometheus metric labels.
+const (
+	LabelClientType = "client_type"
+	LabelClientID   = "client_id"
+	LabelUpdateType = "update_type"
+	LabelMsgType    = "msg_type"
+)

x/ibc/core/keeper/msg_server.go

@@ -13,6 +13,7 @@ import (
 	channel "github.com/cosmos/cosmos-sdk/x/ibc/core/04-channel"
 	channeltypes "github.com/cosmos/cosmos-sdk/x/ibc/core/04-channel/types"
 	porttypes "github.com/cosmos/cosmos-sdk/x/ibc/core/05-port/types"
+	coretypes "github.com/cosmos/cosmos-sdk/x/ibc/core/types"
 )
 
 var _ clienttypes.MsgServer = Keeper{}
@@ -462,10 +463,10 @@ func (k Keeper) RecvPacket(goCtx context.Context, msg *channeltypes.MsgRecvPacke
 			[]string{"tx", "msg", "ibc", msg.Type()},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("source-port", msg.Packet.SourcePort),
-				telemetry.NewLabel("source-channel", msg.Packet.SourceChannel),
-				telemetry.NewLabel("destination-port", msg.Packet.DestinationPort),
-				telemetry.NewLabel("destination-channel", msg.Packet.DestinationChannel),
+				telemetry.NewLabel(coretypes.LabelSourcePort, msg.Packet.SourcePort),
+				telemetry.NewLabel(coretypes.LabelSourceChannel, msg.Packet.SourceChannel),
+				telemetry.NewLabel(coretypes.LabelDestinationPort, msg.Packet.DestinationPort),
+				telemetry.NewLabel(coretypes.LabelDestinationChannel, msg.Packet.DestinationChannel),
 			},
 		)
 	}()
@@ -509,11 +510,11 @@ func (k Keeper) Timeout(goCtx context.Context, msg *channeltypes.MsgTimeout) (*c
 			[]string{"ibc", "timeout", "packet"},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("source-port", msg.Packet.SourcePort),
-				telemetry.NewLabel("source-channel", msg.Packet.SourceChannel),
-				telemetry.NewLabel("destination-port", msg.Packet.DestinationPort),
-				telemetry.NewLabel("destination-channel", msg.Packet.DestinationChannel),
-				telemetry.NewLabel("timeout-type", "height"),
+				telemetry.NewLabel(coretypes.LabelSourcePort, msg.Packet.SourcePort),
+				telemetry.NewLabel(coretypes.LabelSourceChannel, msg.Packet.SourceChannel),
+				telemetry.NewLabel(coretypes.LabelDestinationPort, msg.Packet.DestinationPort),
+				telemetry.NewLabel(coretypes.LabelDestinationChannel, msg.Packet.DestinationChannel),
+				telemetry.NewLabel(coretypes.LabelTimeoutType, "height"),
 			},
 		)
 	}()
@@ -560,11 +561,11 @@ func (k Keeper) TimeoutOnClose(goCtx context.Context, msg *channeltypes.MsgTimeo
 			[]string{"ibc", "timeout", "packet"},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("source-port", msg.Packet.SourcePort),
-				telemetry.NewLabel("source-channel", msg.Packet.SourceChannel),
-				telemetry.NewLabel("destination-port", msg.Packet.DestinationPort),
-				telemetry.NewLabel("destination-channel", msg.Packet.DestinationChannel),
-				telemetry.NewLabel("timeout-type", "channel-closed"),
+				telemetry.NewLabel(coretypes.LabelSourcePort, msg.Packet.SourcePort),
+				telemetry.NewLabel(coretypes.LabelSourceChannel, msg.Packet.SourceChannel),
+				telemetry.NewLabel(coretypes.LabelDestinationPort, msg.Packet.DestinationPort),
+				telemetry.NewLabel(coretypes.LabelDestinationChannel, msg.Packet.DestinationChannel),
+				telemetry.NewLabel(coretypes.LabelTimeoutType, "channel-closed"),
 			},
 		)
 	}()
@@ -604,10 +605,10 @@ func (k Keeper) Acknowledgement(goCtx context.Context, msg *channeltypes.MsgAckn
 			[]string{"tx", "msg", "ibc", msg.Type()},
 			1,
 			[]metrics.Label{
-				telemetry.NewLabel("source-port", msg.Packet.SourcePort),
-				telemetry.NewLabel("source-channel", msg.Packet.SourceChannel),
-				telemetry.NewLabel("destination-port", msg.Packet.DestinationPort),
-				telemetry.NewLabel("destination-channel", msg.Packet.DestinationChannel),
+				telemetry.NewLabel(coretypes.LabelSourcePort, msg.Packet.SourcePort),
+				telemetry.NewLabel(coretypes.LabelSourceChannel, msg.Packet.SourceChannel),
+				telemetry.NewLabel(coretypes.LabelDestinationPort, msg.Packet.DestinationPort),
+				telemetry.NewLabel(coretypes.LabelDestinationChannel, msg.Packet.DestinationChannel),
 			},
 		)
 	}()

x/ibc/core/types/metrics.go

@@ -0,0 +1,12 @@
+package types
+
+// Prometheus metric labels.
+const (
+	LabelSourcePort         = "source_port"
+	LabelSourceChannel      = "source_channel"
+	LabelDestinationPort    = "destination_port"
+	LabelDestinationChannel = "destination_channel"
+	LabelTimeoutType        = "timeout_type"
+	LabelDenom              = "denom"
+	LabelSource             = "source"
+)