synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

add metrics for alerting #2806

Closed trajan0x closed 1 week ago

trajan0x commented 1 week ago

Description

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The recent code changes involve various updates, including changes to import paths, function parameters, and dependencies. Key adjustments include the switch from instrumentation to httpcapture for HTTP transport capturing, introduction of new middleware, restructuring of testing suites, and the addition of new metrics. Modifications also extend to adding new dependencies, improving CORS configurations, and enhancing command functionality for a Slack bot.

Changes

Files Change Summary
contrib/promexporter/exporters/exporter.go Updated import paths and replaced usage of instrumentation.NewCaptureTransport with httpcapture.NewCaptureTransport
contrib/promexporter/go.mod Removed dependency on github.com/google/go-cmp v0.6.0
contrib/promexporter/internal/gql/explorer/contrib/main.go Replaced util2.WaitForStart with ginhelper.WaitForStart
core/ginhelper/* Added server timeout management, updated context handling for HTTP requests, and modified CORS configuration using constants
core/go.mod Added indirect dependencies on github.com/stretchr/objx and go.opentelemetry.io/otel/exporters/stdout/stdoutmetric
core/metrics/instrumentation/httpcapture/* Package comment added, function updated to include handler parameter, and new test suite HTTPCaptureSuite
core/metrics/metrics.go Added //go:generate directive for mock generation and updated Gin() method in Handler interface to return a slice
core/metrics/instrumentation/otelginmetrics/* Added Recorder interface for HTTP metrics and functions to retrieve versions
ethergo/submitter/* Added gas balance metrics, new functions for recording balance, and updated related structures
.golangci.yml Skipped linting for otelginmetrics/* directory
contrib/opbot/* Added signozEnabled field, methods for middleware and commands, and new dependencies
core/metrics/mocks/handler.go Introduced autogeneration of mock Handler with various mock methods
core/metrics/tester.go Added helper functions to retrieve information from tracetest.SpanStub for testing
core/bytes_test.go Iterated over test cases using an index variable i
core/metrics/instrumentation/otelginmetrics/recorder.go Introduced Recorder interface for tracking and observing HTTP metrics
core/metrics/instrumentation/otelginmetrics/version.go Added functions to retrieve release version and semantic version
contrib/opbot/botmd/* Added signozEnabled field and functions for handling Signoz configuration in commands and middleware
core/metrics/null.go Modified Gin method in nullHandler to return a slice of gin.HandlerFunc
contrib/scribe-api/scribe/scribe.go Modified router.Use call in NewScribe to use variadic arguments

Poem

In the realm of code so bright, Changes bloom like stars at night. ✨ Metrics hum a rhythmic song, Tracing paths where bytes belong. Middleware ascends with grace, Handling tasks in every space. Rabbits cheer with joyful hue, Code evolves, refreshed, anew. 🌼


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 1 week ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 661c235
Status: ✅  Deploy successful!
Preview URL: https://3f50ebb5.sanguine-fe.pages.dev
Branch Preview URL: https://fix-http-capture-test.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 9.09091% with 330 lines in your changes missing coverage. Please review.

Project coverage is 25.55824%. Comparing base (8d04213) to head (661c235). Report is 10 commits behind head on master.

Files Patch % Lines
...trics/instrumentation/otelginmetrics/middleware.go 0.00000% 69 Missing :warning:
contrib/opbot/botmd/middleware.go 0.00000% 58 Missing :warning:
...ics/instrumentation/otelginmetrics/example/main.go 0.00000% 40 Missing :warning:
...e/metrics/instrumentation/otelginmetrics/option.go 0.00000% 30 Missing :warning:
...ics/instrumentation/otelginmetrics/otelrecorder.go 0.00000% 29 Missing :warning:
...e/metrics/instrumentation/otelginmetrics/config.go 0.00000% 22 Missing :warning:
ethergo/submitter/chain_queue.go 8.69565% 21 Missing :warning:
core/metrics/tester.go 0.00000% 18 Missing :warning:
contrib/opbot/botmd/commands.go 0.00000% 14 Missing :warning:
contrib/opbot/botmd/botmd.go 0.00000% 10 Missing :warning:
... and 9 more
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2806 +/- ## =================================================== - Coverage 25.59422% 25.55824% -0.03598% =================================================== Files 758 765 +7 Lines 54399 54726 +327 Branches 80 80 =================================================== + Hits 13923 13987 +64 - Misses 39044 39304 +260 - Partials 1432 1435 +3 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [agents](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `34.24556% <ø> (+0.14792%)` | :arrow_up: | | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.93780% <ø> (ø)` | | | [core](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `58.67396% <5.30973%> (-2.74666%)` | :arrow_down: | | [ethergo](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `48.44643% <40.00000%> (-0.05623%)` | :arrow_down: | | [explorer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `4.97877% <100.00000%> (ø)` | | | [git-changes-action](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `23.69615% <ø> (ø)` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `33.08129% <0.00000%> (ø)` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.21067% <0.00000%> (-0.01239%)` | :arrow_down: | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `8.50242% <0.00000%> (-1.36475%)` | :arrow_down: | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `27.16074% <ø> (+0.03911%)` | :arrow_up: | | [screener-api](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `30.28765% <100.00000%> (-0.22082%)` | :arrow_down: | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `18.11159% <100.00000%> (-0.06438%)` | :arrow_down: | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/2806/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `30.55118% <ø> (ø)` | | 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.