Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add telemetry reporting for packet methods #7673

Merged
merged 1 commit into from
Dec 16, 2024
Merged

chore: add telemetry reporting for packet methods #7673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions modules/core/04-channel/v2/keeper/msg_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ func (k *Keeper) Acknowledgement(ctx context.Context, msg *types.MsgAcknowledgem
}
}

defer telemetry.ReportAcknowledgePacket(msg.Packet)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defer call already existed for recv


return &types.MsgAcknowledgementResponse{Result: types.SUCCESS}, nil
}

Expand Down Expand Up @@ -265,5 +267,7 @@ func (k *Keeper) Timeout(ctx context.Context, timeout *types.MsgTimeout) (*types
}
}

defer telemetry.ReportTimeoutPacket(timeout.Packet)

return &types.MsgTimeoutResponse{Result: types.SUCCESS}, nil
}
56 changes: 49 additions & 7 deletions modules/core/internal/v2/telemetry/packet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,56 @@
package telemetry

import (
channeltypesv2 "github.com/cosmos/ibc-go/v9/modules/core/04-channel/v2/types"
metrics "github.com/hashicorp/go-metrics"

"github.com/cosmos/cosmos-sdk/telemetry"

"github.com/cosmos/ibc-go/v9/modules/core/04-channel/v2/types"
ibcmetrics "github.com/cosmos/ibc-go/v9/modules/core/metrics"
)

// ReportRecvPacket TODO: https://github.com/cosmos/ibc-go/issues/7437
func ReportRecvPacket(packet channeltypesv2.Packet) {}
func ReportRecvPacket(packet types.Packet) {
for _, payload := range packet.Payloads {
telemetry.IncrCounterWithLabels(
[]string{"tx", "msg", "ibc", types.EventTypeRecvPacket},
1,
[]metrics.Label{
telemetry.NewLabel(ibcmetrics.LabelSourcePort, payload.SourcePort),
telemetry.NewLabel(ibcmetrics.LabelSourceChannel, packet.SourceChannel),
telemetry.NewLabel(ibcmetrics.LabelDestinationPort, payload.DestinationPort),
telemetry.NewLabel(ibcmetrics.LabelDestinationChannel, packet.DestinationChannel),
Comment on lines +18 to +21
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kept same labels here, unsure if more/less is needed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would imagine it's fine. If we need more, someone will probably tell us.

},
)
}
}

// ReportTimeoutPacket TODO: https://github.com/cosmos/ibc-go/issues/7437
func ReportTimeoutPacket(packet channeltypesv2.Packet, timeoutType string) {}
func ReportTimeoutPacket(packet types.Packet) {
for _, payload := range packet.Payloads {
telemetry.IncrCounterWithLabels(
[]string{"ibc", "timeout", "packet"},
1,
[]metrics.Label{
telemetry.NewLabel(ibcmetrics.LabelSourcePort, payload.SourcePort),
telemetry.NewLabel(ibcmetrics.LabelSourceChannel, packet.SourceChannel),
telemetry.NewLabel(ibcmetrics.LabelDestinationPort, payload.DestinationPort),
telemetry.NewLabel(ibcmetrics.LabelDestinationChannel, packet.DestinationChannel),
telemetry.NewLabel(ibcmetrics.LabelTimeoutType, "height"),
},
)
}
}

// ReportAcknowledgePacket TODO: https://github.com/cosmos/ibc-go/issues/7437
func ReportAcknowledgePacket(packet channeltypesv2.Packet) {}
func ReportAcknowledgePacket(packet types.Packet) {
for _, payload := range packet.Payloads {
telemetry.IncrCounterWithLabels(
[]string{"tx", "msg", "ibc", types.EventTypeAcknowledgePacket},
1,
[]metrics.Label{
telemetry.NewLabel(ibcmetrics.LabelSourcePort, payload.SourcePort),
telemetry.NewLabel(ibcmetrics.LabelSourceChannel, packet.SourceChannel),
telemetry.NewLabel(ibcmetrics.LabelDestinationPort, payload.DestinationPort),
telemetry.NewLabel(ibcmetrics.LabelDestinationChannel, packet.DestinationChannel),
},
)
}
}
Loading