feat(metrics): add blocked and unblocked counter metrics to screener

golangisfun123 commented 2 weeks 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 tracking for blocked and unblocked addresses in the screener functionality.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in screener.go implement new metrics functionality using OpenTelemetry to track blocked and unblocked addresses in the Screener API. This involves importing the go.opentelemetry.io/otel/metric package, defining a meterName constant, and adding counters for blocked and unblocked addresses in the screenerImpl struct.

Changes

File Path	Change Summary
`contrib/screener-api/screener/screener.go`	Added `go.opentelemetry.io/otel/metric` import, `meterName` constant, and metrics counters for tracking blocked and unblocked addresses.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Screener
    participant Metric

    User->>Screener: Request address screening
    Screener->>Screener: Check if address is blocked

    alt Address is blocked
        Screener->>Metric: Increment blockedAddressesMetric
        Screener->>User: Address blocked response
    else Address is unblocked
        Screener->>Metric: Increment unblockedAddressesMetric
        Screener->>User: Address unblocked response
    end

Poem

In the realm of code, we see, Metrics bloom, like flowers free. Blocked and unblocked, they do grow, Tracked with care, data flows. Screener’s watch, vigilant and bright, Monitors all with metrics' light. 🌟

[!WARNING]

Review ran into problems

Problems (1)
* Git: Failed to clone repository. Please contact CodeRabbit support.

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

Latest commit:	`a884926`
Status:	✅ Deploy successful!
Preview URL:	https://56fbda24.sanguine-fe.pages.dev
Branch Preview URL:	https://add-bl-metrics.sanguine-fe.pages.dev

View logs

codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 50.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 25.66164%. Comparing base (15d18e8) to head (a884926). Report is 2 commits behind head on master.

Files	Patch %	Lines
contrib/screener-api/screener/screener.go	50.00000%	4 Missing and 2 partials :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #2862 +/- ## =================================================== + Coverage 25.63862% 25.66164% +0.02301% =================================================== Files 770 770 Lines 55393 55468 +75 Branches 80 80 =================================================== + Hits 14202 14234 +32 - Misses 39715 39752 +37 - Partials 1476 1482 +6 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2862/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/2862/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/2862/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.18564% <ø> (ø)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2862/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `24.77165% <ø> (+0.16532%)` | :arrow_up: | | [screener-api](https://app.codecov.io/gh/synapsecns/sanguine/pull/2862/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `30.19802% <50.00000%> (+0.40004%)` | :arrow_up: | 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.

trajan0x commented 5 days ago

@golangisfun123 did we stage?

synapsecns / sanguine