feat(metrics): add last committed and finalized batch metrics

[WorldDogs]

Summary by CodeRabbit

• New Features
  • Introduced two new monitoring metrics for tracking the latest committed and finalized batches.
  • Enhanced the rollup process with additional checks and error logging for these batch indices, providing improved visibility into system progress.

[coderabbitai]

Walkthrough

This update introduces two new Prometheus metrics—LastCommittedBatch and LastFinalizedBatch—into the Metrics struct. The NewMetrics function now initializes and registers these metrics, and corresponding setter methods have been added. Additionally, the UnregisterMetrics function has been updated to properly unregister the new metrics. In the rollup service, the Start method now retrieves the last committed and finalized batch indices with error handling and updates these metrics accordingly.

Changes

File	Change Summary
tx-submitter/metrics/metrics.go	Added new metrics (LastCommittedBatch, LastFinalizedBatch) to the Metrics struct; updated NewMetrics for initialization and registration; added setter methods and updated UnregisterMetrics for unregistration.
tx-submitter/services/rollup.go	Modified the Start method of Rollup to fetch last committed and finalized batch indices; added error handling and calls to update the new metrics accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Rollup
    participant Metrics
    participant Logger

    Rollup->>Rollup: Fetch Wallet Balance
    Rollup->>Rollup: Retrieve LastCommittedBatchIndex
    alt Committed Batch Retrieval Successful
        Rollup->>Metrics: SetLastCommittedBatch(index)
    else Error Occurs
        Rollup->>Logger: Log warning for committed batch error
    end
    Rollup->>Rollup: Retrieve LastFinalizedBatchIndex
    alt Finalized Batch Retrieval Successful
        Rollup->>Metrics: SetLastFinalizedBatch(index)
    else Error Occurs
        Rollup->>Logger: Log warning for finalized batch error
    end

Loading

Poem

I’m a bunny in the code field so wide,
Hoping new metrics now jump with pride,
Last committed and finalized in sight,
Bounding through errors with warnings so light,
A joyful hop in code’s merry parade!
🐇💻 Happy hops to every update made!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package zstd: could not load export data: no export data for "morph-l2/node/zstd""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package zstd: could not load export data: no export data for "morph-l2/node/zstd""

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8d6969f and 886f697.

📒 Files selected for processing (2)

• tx-submitter/metrics/metrics.go (5 hunks)
• tx-submitter/services/rollup.go (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

tx-submitter/services/rollup.go (1)

bindings/bindings/rollup.go (1)

• Rollup (82-86)

🔇 Additional comments (7)

tx-submitter/services/rollup.go (1)

187-201: Well-implemented batch metrics collection!

The new metrics collection for last committed and finalized batch indices follows the established pattern, with proper error handling and logging. This addition provides valuable insights into the rollup process state.

tx-submitter/metrics/metrics.go (6)

23-24: Good addition of new Prometheus metrics fields

The LastCommittedBatch and LastFinalizedBatch fields are properly defined as Prometheus Gauge types, consistent with other similar metrics in the struct.

---

66-73: Well-defined Prometheus metric configurations

The new metrics have clear, descriptive names with appropriate help text that follows the project's naming conventions.

---

87-101: Improved error handling for metrics registration

Using _ to discard the error return value from prometheus.Register() is better than using MustRegister() as the comment indicates, since it avoids potential panics if metrics are already registered.

---

97-98: Proper registration of new metrics

The new LastCommittedBatch and LastFinalizedBatch metrics are correctly registered with Prometheus.

---

137-145: Well-implemented setter methods for new metrics

The SetLastCommittedBatch and SetLastFinalizedBatch methods follow the established pattern of other setters in this file, providing a clean interface for updating the metric values.

---

193-194: Proper cleanup in UnregisterMetrics

The new metrics are correctly included in the UnregisterMetrics function, ensuring proper cleanup when metrics are no longer needed.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.