feat: prometheus for ibc-hooks

[faddat]

description

This is a semi-speculative PR that aims at making more layers of osmosis visible in order to make what a node is doing at any time clearer.

Testing and Verifying

(Please pick one of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

• Added unit test that validates ...
• Added integration tests for end-to-end deployment with ...
• Extended integration test for ...
• Manually verified the change by ...

Documentation and Release Note

• [ ] Does this pull request introduce a new feature or user-facing behavior changes?
• [ ] Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

• [ ] Specification (x/{module}/README.md)
• [ ] Osmosis documentation site
• [ ] Code comments?
• [ ] N/A

Summary by CodeRabbit

• New Features
  • Introduced Prometheus metrics for tracking IBC packet routing to contracts and related failures.

[github-actions[bot]]

Important Notice

This PR modifies an in-repo Go module. It is one of:

• osmomath
• osmoutils
• x/ibc-hooks
• x/epochs

The dependent Go modules, especially the root one, will have to be updated to reflect the changes. Failing to do so might cause e2e to fail.

Please follow the instructions below:

1. Open https://github.com/osmosis-labs/osmosis/actions/workflows/go-mod-auto-bump.yml
2. Provide the current branch name
3. On success, confirm if an automated commit corretly updated the go.mod and go.sum files

Please let us know if you need any help.

[coderabbitai[bot]]

Walkthrough

This update introduces Prometheus metrics within the IBC (Inter-Blockchain Communication) protocol, specifically focusing on tracking the routing of packets to contracts and identifying any failures in this process. This enhancement aims to improve monitoring and reliability by providing insights into the performance and success rates of packet routing, essential for maintaining robust inter-chain operations.

Changes

File(s)	Change Summary
x/ibc-hooks/metrics.go	Added Prometheus metrics for tracking IBC packets routed to contracts and failures in routing.

🐇✨
In the realm of code, where packets fly,
A rabbit hopped, beneath the digital sky.
"Let's track," it said, "where these packets roam,
And guide each one, safely to its home."
With metrics gathered, both far and wide,
It watched them all, with eyes open wide.
"Through IBC paths, they'll never stray,
For we're here to guide them, every step of the way."
🌐🚀

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[faddat]

@mattverse is this interesting? if not, I can close it, it kinda came up while I was working on some other stuff.

[github-actions[bot]]

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

[mattverse]

@nicolaslara Thoughts on this by any chance? 👀

[github-actions[bot]]

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

[nicolaslara]

yeah, I think having monitoring for this is good. This PR only has the event definition and everything else is on a txt though. @p0mvn do we have a strategy for adding monitoring or should we just add it incrementally whenever we can?

[PaddyMc]

Thanks for creating this PR, I think I'll close for the moment and we've documented this internally to use this as a reference if we come back to this :smile: