search

synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

add uptime metric [SLT-372] #3321

Closed trajan0x closed 1 month ago

trajan0x commented 1 month ago

Description

Introduces an uptime metric

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve updates to the documentation in core/metrics/README.md, modifications to the baseHandler struct in core/metrics/base.go, and the introduction of a new file core/metrics/standard.go that implements a metrics handling system using OpenTelemetry. The documentation clarifies environment variable configurations, while the code changes include a deprecation notice for a field in base.go and the addition of a new metrics struct and related functions in standard.go.

Changes

File Change Summary
core/metrics/README.md Updated documentation for metrics package, clarified METRICS_HANDLER, corrected spelling errors, and enhanced descriptions for OTLP exporters.
core/metrics/base.go Added deprecation comment for meter field in baseHandler, reorganized imports, and introduced newStandardMetrics(ctx, b) function call.
core/metrics/standard.go Introduced standardMetrics struct for service metrics, added newStandardMetrics function, and implemented uptimeCallback method for uptime tracking.

Possibly related PRs

Suggested labels

size/m

🐇 In the meadow, metrics bloom,
With handlers set to chase the gloom.
A gauge for uptime, clear and bright,
Documented well, it feels just right!
With deprecations, we tidy the space,
In the world of code, we find our place! 🌼

📜 Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 3fa1d71a0d7029417628c07e6a9394a6aa7e1d2a and a96ea1d500768c30e863ec9431b76adb790ad4db.
📒 Files selected for processing (1) * core/metrics/base.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * core/metrics/base.go
--- 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.
codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 33.24611%. Comparing base (6415acd) to head (a96ea1d). Report is 20 commits behind head on master.

Files with missing lines Patch % Lines
core/metrics/standard.go 44.44444% 8 Missing and 2 partials :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3321 +/- ## =================================================== + Coverage 31.92469% 33.24611% +1.32142% =================================================== Files 238 543 +305 Lines 14553 34777 +20224 Branches 356 82 -274 =================================================== + Hits 4646 11562 +6916 - Misses 9614 22190 +12576 - Partials 293 1025 +732 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/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/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.97848% <ø> (?)` | | | [core](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `58.63676% <50.00000%> (?)` | | | [ethergo](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `47.31849% <ø> (?)` | | | [git-changes-action](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `23.48315% <ø> (?)` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `32.66914% <ø> (?)` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/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/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.81642% <ø> (ø)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `24.64558% <ø> (+0.03270%)` | :arrow_up: | | [screener-api](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `29.45990% <ø> (?)` | | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `18.24614% <ø> (?)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/3321/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.

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

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: a96ea1d
Status: ✅  Deploy successful!
Preview URL: https://f99b51a4.sanguine-fe.pages.dev
Branch Preview URL: https://fix-uptime-metric.sanguine-fe.pages.dev

View logs