search

synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 27 forks source link

RFQ Relayer: add request status count metric #2856

Closed dwasse closed 2 weeks ago

dwasse commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

These changes introduce metrics recording with OpenTelemetry into the RFQ (Request For Quote) service's relayer component. A new otelRecorder is implemented along with methods to retrieve and record the status counts of quote requests. The relayer has been modified to periodically record these metrics, and new panels have been added to the dashboard JSON configuration.

Changes

File(s) Summary
services/rfq/go.mod Added github.com/cornelk/hashmap v1.0.8 as a direct dependency, removing it as an indirect dependency.
services/rfq/relayer/reldb/base/quote.go Added GetStatusCounts method to Store type to retrieve quote request counts by status.
services/rfq/relayer/reldb/db.go Added GetStatusCounts method to Reader interface to retrieve quote request counts by status.
services/rfq/relayer/service/otel.go (both changesets) Introduced otelRecorder for metrics recording with OpenTelemetry, including initialization and methods.
services/rfq/relayer/service/otel_generated.go Added iOtelRecorder interface with RecordStatusCount method for status count recording.
services/rfq/relayer/service/relayer.go Updated Relayer struct and NewRelayer function; added recordMetrics method.
docs/bridge/docs/rfq/Relayer/Relayer.md Documented new status_count metric for relayer.
services/rfq/relayer/dashboards/dashboard.json Updated multiple fields and added new panels for metrics monitoring.

Poem

In the land of code where numbers soar,
Metrics whisper, "Record me more!" πŸ“Š
With OpenTelemetry's guiding light,
Status counts in metrics' flight. 🌠
This relayer's metrics now refined,
Dashboards glow, insights aligned.
Oh, the tales our data tells,
In quote requests where logic dwells. πŸ‡βœ¨

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 .` - `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 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 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 as 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. 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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
cloudflare-pages[bot] commented 2 weeks ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3e0dc86
Status: βœ…  Deploy successful!
Preview URL: https://04759448.sanguine-fe.pages.dev
Branch Preview URL: https://feat-status-metric.sanguine-fe.pages.dev

View logs

codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 76 lines in your changes missing coverage. Please review.

Project coverage is 25.61864%. Comparing base (9779cda) to head (3e0dc86).

Files Patch % Lines
services/rfq/relayer/service/otel.go 0.00000% 31 Missing :warning:
services/rfq/relayer/service/relayer.go 0.00000% 24 Missing :warning:
services/rfq/relayer/reldb/base/quote.go 0.00000% 21 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2856 +/- ## =================================================== + Coverage 25.35936% 25.61864% +0.25928% =================================================== Files 784 769 -15 Lines 56350 55323 -1027 Branches 80 80 =================================================== - Hits 14290 14173 -117 + Misses 40581 39677 -904 + Partials 1479 1473 -6 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2856/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Ξ” | | |---|---|---| | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2856/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.18564% <ΓΈ> (ΓΈ)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2856/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.