Skip to content

feat: add metrics finalized block #1172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 15, 2025
Merged

Conversation

yiweichi
Copy link
Member

@yiweichi yiweichi commented Apr 23, 2025

1. Purpose or design rationale of this PR

add metrics chain/head/finalized

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • This PR doesn't involve a new deployment, git tag, docker image tag, and it doesn't affect traces
  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change
  • Yes

Summary by CodeRabbit

  • New Features
    • Added a new metric to monitor the finalized L2 block height for improved visibility into synchronization status.

Copy link

coderabbitai bot commented Apr 23, 2025

Walkthrough

A new metrics gauge, finalizedBlockGauge, has been introduced to monitor the finalized L2 block height. The gauge is initialized at service startup and updated both at startup and after new finalized L2 blocks are written to the database. No other logic or control flow has been modified.

Changes

File(s) Change Summary
rollup/rollup_sync_service/rollup_sync_service.go Added finalizedBlockGauge metric for finalized L2 block height; grouped it with an existing error variable; updated gauge during service startup and after database writes.

Sequence Diagram(s)

sequenceDiagram
    participant Service as RollupSyncService
    participant DB as Database
    participant Metrics as finalizedBlockGauge

    Service->>DB: Read last finalized L2 block on Start()
    alt If value present
        Service->>Metrics: Update gauge with block number
    end

    loop On updateRollupEvents
        Service->>DB: Write highest finalized L2 block
        Service->>Metrics: Update gauge with new value
    end
Loading

Poem

A gauge now tracks the blocks we see,
Finalized heights, as clear as can be.
With each new block, the numbers grow,
Metrics updated, in a steady flow.
The service hops, the data shines—
Another leap in metric lines!
🐇📊

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 49b2e3f and be33b3c.

📒 Files selected for processing (1)
  • rollup/rollup_sync_service/rollup_sync_service.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • rollup/rollup_sync_service/rollup_sync_service.go
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test
  • GitHub Check: Analyze (go)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
rollup/rollup_sync_service/rollup_sync_service.go (1)

49-49: Error string should be lowercase and descriptive.
Go error strings should not start with the type name or be capitalized. Consider changing the message to a lower-case sentence:

- ErrShouldResetSyncHeight = errors.New("ErrShouldResetSyncHeight")
+ ErrShouldResetSyncHeight = errors.New("should reset sync height")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d178b00 and 0732859.

📒 Files selected for processing (2)
  • params/version.go (1 hunks)
  • rollup/rollup_sync_service/rollup_sync_service.go (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test
  • GitHub Check: Analyze (go)
  • GitHub Check: build-and-push
🔇 Additional comments (5)
params/version.go (1)

27-27: Version bump approved.
The patch version constant is correctly incremented from 39 to 40, reflecting the addition of the new finalized block metric without introducing breaking changes.

rollup/rollup_sync_service/rollup_sync_service.go (4)

20-20: Metrics import added correctly.
The metrics package import enables gauge registration for finalized block heights. No conflicts detected with existing imports.


48-48: Finalize gauge declared and registered.
The finalizedBlockGauge is registered globally under "chain/head/finalized", which aligns with other chain metrics naming conventions.


144-147: Initialize gauge on service start.
Loading the last finalized L2 block number at startup and immediately updating the gauge ensures metrics continuity across restarts. This correctly handles the nil case.


335-335: Update gauge upon finalization.
Updating finalizedBlockGauge after writing the new highest finalized block number ensures real-time metric accuracy for each FinalizeBatch event.

@yiweichi yiweichi requested a review from Thegaram April 28, 2025 20:39
@yiweichi yiweichi requested a review from colinlyguo April 30, 2025 12:34
@yiweichi yiweichi merged commit aba2ddd into develop May 15, 2025
14 checks passed
@yiweichi yiweichi deleted the feat-add-metrics-finalized-block branch May 15, 2025 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants