Skip to content
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

Initialize keys and balance metrics on startup #770

Merged
merged 4 commits into from
Feb 28, 2025

Conversation

peterargue
Copy link
Contributor

@peterargue peterargue commented Feb 25, 2025

Closes: #???

Description

The available keys and operator balance metrics are currently only updated when transactions are sent. This makes it may take several minutes before they are initialized after a reboot, or never if the node sees little traffic. That's caused problems using these metrics for alerting.

This PR updates the EVM module to initialize them during startup.


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced the initialization process to ensure up-to-date account balance and security key information.
  • Refactor

    • Streamlined the return process for the component creation flow, improving efficiency and clarity.

Copy link
Contributor

coderabbitai bot commented Feb 25, 2025

Walkthrough

The change updates the NewEVM function in services/requester/requester.go to enhance the tracking of metrics related to transaction processing. It adds calls to collector.AvailableSigningKeys(keystore.AvailableKeys()) and collector.OperatorBalance(acc) to log available signing keys and the operator's balance, respectively. Additionally, the return statement has been simplified to directly return the new EVM instance.

Changes

File Change Summary
services/requester/requester.go Added call to collector.AvailableSigningKeys(keystore.AvailableKeys()) after logger initialization and collector.OperatorBalance(acc) after account retrieval. Simplified return statement to directly return the new EVM instance.

Sequence Diagram(s)

sequenceDiagram
    participant R as Requester
    participant E as NewEVM Function
    participant C as Collector
    participant K as Keystore

    R->>E: Call NewEVM()
    E->>K: AvailableKeys()
    K-->>E: Return keys
    E->>C: AvailableSigningKeys(keys)
    E->>E: Retrieve account (acc)
    E->>C: OperatorBalance(acc)
    E-->>R: Return new EVM instance
Loading

Possibly related PRs

Suggested reviewers

  • m-Peter
  • zhangchiqing

Poem

I'm a happy rabbit with a hop and a cheer,
As code sprouts new features, bringing news that is clear.
Collector gathers balances and keys with grace,
In our little warren, improvements set the pace.
Code carrots crunch as bugs scurry away,
With joyful hops in this brilliant display!
🐇 Happy coding all day!


📜 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 b752576 and 7964df9.

📒 Files selected for processing (1)
  • services/requester/requester.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • services/requester/requester.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test

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
🪧 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 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.

@peterargue peterargue force-pushed the peter/initialize-available-keys branch from 57c8758 to d1bbd20 Compare February 25, 2025 18:21
Copy link
Collaborator

@m-Peter m-Peter left a comment

Choose a reason for hiding this comment

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

Nice catch 💯

@peterargue peterargue merged commit 44ca5b4 into main Feb 28, 2025
2 checks passed
@peterargue peterargue deleted the peter/initialize-available-keys branch February 28, 2025 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants