[SLT-331] feat(omnirpc): omnirpc request tracing

golangisfun123 commented 1 month ago

Description A clear and concise description of the features you're adding in this pull request.

Additional context Add any other context about the problem you're solving.

Metadata

Fixes #[Link to Issue]

Summary by CodeRabbit

New Features
- Introduced metrics and tracing capabilities across various request handling structures.
- Added WithMetrics method to associate requests with metrics handling.
- Enhanced client initialization to include metrics handling across multiple services.
Bug Fixes
- Improved error handling and logging in request methods.
- Corrected indexing for string representation of ActiveQuoteRequestStatus constants.
Chores
- Updated import statements for better code quality.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request enhance the functionality of various structures and methods within the omnirpc service, primarily focusing on metrics and tracing integration. Key modifications include the addition of a metrics handler field in several request-related structures, the introduction of new methods for setting this handler, and updates to existing methods to incorporate tracing functionality. The changes also involve some field removals and method signature updates to accommodate these enhancements.

Changes

File Path	Change Summary
`services/omnirpc/http/capture_client.go`	- Added `handler metrics.Handler` field to `CaptureClient` and `CapturedRequest`. - Updated `NewCaptureClient` and `NewRequest` methods. - Enhanced methods to include tracing spans.
`services/omnirpc/http/client.go`	- Modified `NewClient` method to accept `metrics.Handler` parameter.
`services/omnirpc/http/fasthttp.go`	- Added `handler metrics.Handler` field to `fastHTTPRequest` and `fastHTTPClient`. - Updated `NewFastHTTPClient` method. - Enhanced methods to include tracing spans.
`services/omnirpc/http/resty.go`	- Added `handler metrics.Handler` field to `RestyClient` and `restyRequest`. - Updated `NewRestyClient` method. - Enhanced methods to include tracing spans and improved error handling.
`services/omnirpc/proxy/forward.go`	- Updated import statements. - Modified `forwardRequest` method to use `f.handler.Tracer()`. - Added metrics integration.
`services/omnirpc/proxy/forwarder.go`	- Removed `tracer` field and added `handler metrics.Handler`. - Updated methods to use the new `handler`.
`services/omnirpc/proxy/server.go`	- Removed `tracer` field from `RPCProxy`. - Updated `NewProxy` method to include `handler` parameter.
`services/omnirpc/modules/confirmedtofinalized/finalizedproxy.go`	- Updated `NewProxy` method to include `handler` parameter.
`services/omnirpc/modules/harmonyproxy/harmonyproxy.go`	- Updated `NewHarmonyProxy` method to include `handler` parameter. - Enhanced error handling in `ProxyRequest` method.
`services/omnirpc/modules/receiptsbackup/receiptsbackup.go`	- Updated `NewProxy` method to include `handler` parameter.
`services/rfq/api/db/activequoterequeststatus_string.go`	- Updated `_ActiveQuoteRequestStatus_index` variable to adjust indexing for string representation.

Possibly related PRs

#2682: This PR integrates Prometheus gauge metrics into the RFQ API, which aligns with the main PR's focus on enhancing metrics handling through the integration of a metrics.Handler.
#2701: This PR addresses issues related to the Prometheus setup within the RFQ API, which is relevant to the main PR's changes that enhance metrics handling.
#2856: This PR adds a request status count metric, which is related to the metrics handling improvements in the main PR.
#3198: This PR enhances the relayer to support active quoting, which may involve metrics tracking similar to the changes in the main PR.

Suggested labels

M-docs

Suggested reviewers

aureliusbtc
trajan0x

🐰 In the meadow, we hop and play,
Metrics and tracing lead the way!
With handlers added, our requests are bright,
In the code we dance, a joyful sight!
Let's celebrate changes, both big and small,
Together we thrive, together we call! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`cf9763f`
Status:	✅ Deploy successful!
Preview URL:	https://b364e3d8.sanguine-fe.pages.dev
Branch Preview URL:	https://omnirpc-request-tracing.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 87.14286% with 9 lines in your changes missing coverage. Please review.

Project coverage is 30.71720%. Comparing base (791b0ef) to head (cf9763f). Report is 73 commits behind head on master.

Files with missing lines	Patch %	Lines
services/omnirpc/http/capture_client.go	81.25000%	2 Missing and 1 partial :warning:
services/omnirpc/http/resty.go	81.25000%	2 Missing and 1 partial :warning:
...rpc/modules/confirmedtofinalized/finalizedproxy.go	0.00000%	1 Missing :warning:
...vices/omnirpc/modules/harmonyproxy/harmonyproxy.go	0.00000%	1 Missing :warning:
...s/omnirpc/modules/receiptsbackup/receiptsbackup.go	0.00000%	1 Missing :warning:

:exclamation: There is a different number of reports uploaded between BASE (791b0ef) and HEAD (cf9763f). Click for more details.

HEAD has 2 uploads less than BASE
| Flag | BASE (791b0ef) | HEAD (cf9763f) | |------|------|------| |solidity|2|0|

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3289 +/- ## ==================================================== - Coverage 93.56415% 30.71720% -62.84695% ==================================================== Files 94 447 +353 Lines 2455 29866 +27411 Branches 356 82 -274 ==================================================== + Hits 2297 9174 +6877 - Misses 149 19838 +19689 - Partials 9 854 +845 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3289/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/3289/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.97848% <ø> (?)` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/3289/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.48870% <ø> (?)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3289/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.81642% <ø> (?)` | | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/3289/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `18.18182% <ø> (?)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3289/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 1 month ago

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

synapsecns / sanguine