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

[Health] Reduce alert spamming #2350

Merged
merged 2 commits into from
Jan 16, 2025

Conversation

nick-bisonai
Copy link
Collaborator

Description

Remove alert for the symbol to be delisted

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.

Deployment

  • Should publish npm package
  • Should publish Docker image

@nick-bisonai nick-bisonai self-assigned this Jan 16, 2025
@nick-bisonai nick-bisonai requested a review from a team as a code owner January 16, 2025 03:39
Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

📝 Walkthrough

Walkthrough

This pull request introduces a new mechanism for handling delisted symbols across multiple packages. A new SymbolsToBeDelisted variable is defined in the checker package, initially containing the symbol "JOY-USDT". The changes modify filtering logic in different components of the system, specifically in the dal and event packages, to skip processing for symbols marked for delisting. This is implemented using the slices.Contains() method to check against the delisted symbols list.

Changes

File Change Summary
node/pkg/checker/delisted.go Added SymbolsToBeDelisted variable with "JOY-USDT"
node/pkg/checker/dal/app.go Added imports for slices and checker packages; Added conditional checks to skip processing for delisted symbols in CheckLastUpdateOffsets and checkDal methods
node/pkg/checker/event/app.go Added imports for slices and checker packages; Modified setUp function to filter out configurations for delisted symbols

Sequence Diagram

sequenceDiagram
    participant Checker
    participant DAL
    participant Event
    
    Checker->>Checker: Define SymbolsToBeDelisted
    DAL->>Checker: Check if symbol is delisted
    Event->>Checker: Check if symbol is delisted
    
    alt Symbol is delisted
        DAL-->>DAL: Skip processing
        Event-->>Event: Skip processing
    end
Loading

Possibly related PRs

Suggested reviewers

  • Intizar-T

Poem

🐰 A rabbit's tale of symbols rare,
Delisted with meticulous care,
Slices and checks, a filtering dance,
JOY-USDT takes its last stance,
Code hops lightly, without despair! 🚫

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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. (Beta)
  • @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
Contributor

@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 (2)
node/pkg/checker/dal/app.go (1)

Line range hint 37-175: Consider adding logging for filtered symbols.

While the filtering logic is correct, adding debug logging when symbols are filtered would help with monitoring and troubleshooting.

 if slices.Contains(checker.SymbolsToBeDelisted, symbol) {
+    log.Debug().Str("symbol", symbol).Msg("Skipping processing for delisted symbol")
     continue
 }
node/pkg/checker/event/app.go (1)

58-60: Consider adding logging for filtered symbols.

While the filtering logic is correct, adding debug logging when symbols are filtered would help with monitoring and troubleshooting.

 if slices.Contains(checker.SymbolsToBeDelisted, config.Name) {
+    log.Debug().Str("symbol", config.Name).Msg("Skipping feed setup for delisted symbol")
     continue
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1a034d5 and 9b2164d.

📒 Files selected for processing (3)
  • node/pkg/checker/dal/app.go (3 hunks)
  • node/pkg/checker/delisted.go (1 hunks)
  • node/pkg/checker/event/app.go (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • node/pkg/checker/delisted.go
🔇 Additional comments (6)
node/pkg/checker/dal/app.go (3)

9-9: LGTM! Required imports added.

The new imports support the symbol filtering functionality.

Also applies to: 15-15


37-39: LGTM! Filtering logic for delisted symbols.

Early continue for delisted symbols effectively reduces alert spamming by preventing unnecessary processing.


173-175: LGTM! Consistent filtering implementation.

The filtering logic is consistently applied across different processing paths, maintaining uniform behavior for delisted symbols.

node/pkg/checker/event/app.go (3)

7-7: LGTM! Required imports added.

The new imports support the symbol filtering functionality.

Also applies to: 12-12


58-60: LGTM! Early filtering of delisted symbols.

Prevents delisted symbols from being included in the FeedsToCheck list, effectively reducing unnecessary processing and alerts.


Line range hint 1-350: Verify the impact on existing alerts.

The changes effectively filter out delisted symbols, but we should verify that other critical alerts remain functional.

✅ Verification successful

Alert functionality remains intact and properly handles symbol filtering

The changes correctly filter out delisted symbols during setup while preserving all critical alert functionality:

  • Feed submission delay alerts continue to work for all active symbols
  • POR (Proof of Reserve) alerts are unaffected as they use separate configuration
  • VRF (Verifiable Random Function) alerts are unaffected as they use separate configuration
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any alert-related code that might be affected
rg -A 3 "SlackAlert\(" --type go

Length of output: 3721

@nick-bisonai nick-bisonai merged commit c12b978 into master Jan 16, 2025
1 check passed
@nick-bisonai nick-bisonai deleted the feat/health-silence-delisting-symbol branch January 16, 2025 04:01
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