Skip to content

feat: pending sweep metrics #977

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

michael1011
Copy link
Member

@michael1011 michael1011 commented Jun 23, 2025

Summary by CodeRabbit

  • New Features
    • Introduced new metrics to monitor the number and total amount of pending sweeps per asset symbol in the system's monitoring dashboard.

Copy link

coderabbitai bot commented Jun 23, 2025

Walkthrough

Two new Prometheus Gauge metrics were introduced in the registerMetrics method of the Prometheus class. These metrics track the count and total amount of pending sweeps per asset symbol by retrieving and aggregating data from the service during metric collection.

Changes

File(s) Change Summary
lib/Prometheus.ts Added two Gauge metrics: boltz_pending_sweep_count and boltz_pending_sweep_amount for tracking pending sweep counts and amounts per symbol.

Poem

In the warren of code, new metrics appear,
Counting sweeps and amounts with labels so clear.
Prometheus now tracks, with diligent care,
Each symbol’s pending sweep, floating in air.
With gauges in place, the numbers will show—
The story of swaps in a rabbit’s data flow!
🐇📊

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.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-23T20_46_04_530Z-debug-0.log

✨ 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)
lib/Prometheus.ts (1)

312-346: Consider optimizing the duplicate service calls and potential precision loss.

Both metrics call service.getPendingSweeps() independently, which could impact performance if metrics collection happens frequently. Additionally, the BigInt to Number conversion in the amount metric could lose precision for very large values.

Optimization approach:

+    // Cache the pending sweeps data for both metrics
+    let pendingSweepsCache: Map<string, any[]> | null = null;
+    const getPendingSweepsOnce = () => {
+      if (pendingSweepsCache === null) {
+        pendingSweepsCache = service.getPendingSweeps();
+      }
+      return pendingSweepsCache;
+    };
+
     this.swapRegistry!.registerMetric(
       new Gauge({
         name: `${Prometheus.metricPrefix}pending_sweep_count`,
         labelNames: ['symbol'],
         help: 'number of pending sweeps',
         collect: function () {
-          const pendingSweeps = service.getPendingSweeps();
+          pendingSweepsCache = null; // Reset cache
+          const pendingSweeps = getPendingSweepsOnce();
           for (const [symbol, swaps] of pendingSweeps.entries()) {
             this.set({ symbol }, swaps.length);
           }
         },
       }),
     );

     this.swapRegistry!.registerMetric(
       new Gauge({
         name: `${Prometheus.metricPrefix}pending_sweep_amount`,
         labelNames: ['symbol'],
         help: 'amount in pending sweeps',
         collect: function () {
-          const pendingSweeps = service.getPendingSweeps();
+          const pendingSweeps = getPendingSweepsOnce();
           for (const [symbol, swaps] of pendingSweeps.entries()) {
             this.set(
               { symbol },
-              Number(
-                swaps.reduce(
-                  (acc, swap) => acc + BigInt(swap.onchainAmount),
-                  0n,
-                ),
-              ),
+              // Consider adding overflow checking for very large amounts
+              Math.min(
+                Number(
+                  swaps.reduce(
+                    (acc, swap) => acc + BigInt(swap.onchainAmount),
+                    0n,
+                  ),
+                ),
+                Number.MAX_SAFE_INTEGER,
+              ),
             );
           }
         },
       }),
     );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd8fa94 and 85537fe.

📒 Files selected for processing (1)
  • lib/Prometheus.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build-rust (ubuntu-latest, 20, stable)
  • GitHub Check: build (ubuntu-latest, 20, stable)
  • GitHub Check: build-rust (ubuntu-latest, 20, stable)
  • GitHub Check: build (ubuntu-latest, 20, stable)
🔇 Additional comments (2)
lib/Prometheus.ts (2)

317-323: LGTM: Clean implementation for pending sweep count metric.

The metric correctly counts pending sweeps per symbol and follows the established patterns in the codebase.


331-344: LGTM: Correct logic for summing pending sweep amounts.

The reduce operation properly accumulates the onchainAmount values using BigInt arithmetic before converting to Number for the metric value.

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.

1 participant