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

(Sentinel) DAL request traffic checker #2078

Merged
merged 4 commits into from
Aug 13, 2024

Conversation

nick-bisonai
Copy link
Collaborator

Description

if request count for last 10 seconds exceeds 100, sends slack message

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

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@nick-bisonai nick-bisonai self-assigned this Aug 13, 2024
@nick-bisonai nick-bisonai requested a review from a team as a code owner August 13, 2024 04:39
Copy link
Contributor

coderabbitai bot commented Aug 13, 2024

Warning

Rate limit exceeded

@nick-bisonai has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 40 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between c8ffe3d and fd7a424.

Walkthrough

Walkthrough

The recent updates enhance the dal package, improving database interactions and error handling. A new structure for WebSocket management has been introduced, including essential data types and concurrency mechanisms. The Start function now enforces stricter error handling and incorporates traffic monitoring, which sends alerts based on defined thresholds. These changes streamline the codebase and promote efficient operations in maintaining database connections and handling WebSocket communications.

Changes

Files Change Summary
node/pkg/checker/dal/app.go Enhanced error handling in Start, added traffic monitoring with Slack alerts, and removed unnecessary constants/types.
node/pkg/checker/dal/types.go Introduced new data structures for WebSocket responses and traffic monitoring, defined constants for thresholds, and established channels for efficient data handling.

Poem

🐰 In the code where bunnies hop,
New structures bloom, and errors stop.
WebSocket whispers, traffic alerts,
Efficiency grows as complexity flirts.
A cleaner path for data's dance,
Hooray for changes—a joyful chance! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 80ada17 and c8ffe3d.

Files selected for processing (2)
  • node/pkg/checker/dal/app.go (4 hunks)
  • node/pkg/checker/dal/types.go (1 hunks)
Additional comments not posted (3)
node/pkg/checker/dal/types.go (2)

9-19: Ensure SQL query security.

The TrafficCheckQuery constant contains a raw SQL query. Ensure that the query is safe from SQL injection and that inputs are properly sanitized.


21-28: Consider buffering channel sizes.

The wsChan and wsMsgChan channels have large buffer sizes (30000 and 10000, respectively). Ensure these sizes are appropriate for your application's expected load and memory usage.

node/pkg/checker/dal/app.go (1)

94-97: Ensure secret retrieval is reliable.

The retrieval of DAL_DB_CONNECTION_URL from secrets is crucial. Ensure that the secrets management system is reliable and that the application can handle scenarios where the secret is temporarily unavailable.

WsPushThreshold = 5 * time.Second
TrafficCheckQuery = `select count(1) from rest_calls where
timestamp > current_timestamp - INTERVAL '10 seconds' AND
api_key NOT IN (SELECT key from keys WHERE description IN ('test', 'sentinel', 'orakl_reporter'))`
Copy link
Contributor

Choose a reason for hiding this comment

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

the hard coded values can get lost easily. I wonder if it's possible to filter these in a more dynamic way... but cannot think of a better way atm. But I guess shouldn't be a problem to leave them like this either 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For now const with those specified keys can be declared and used to generate query, will make an update

Copy link
Contributor

@Intizar-T Intizar-T left a comment

Choose a reason for hiding this comment

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

lgtm!

left a minor comment

@nick-bisonai nick-bisonai linked an issue Aug 13, 2024 that may be closed by this pull request
@nick-bisonai nick-bisonai merged commit 7a2abbf into master Aug 13, 2024
1 check passed
@nick-bisonai nick-bisonai deleted the feat/dal-multi-request-checker branch August 13, 2024 12:10
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.

(Sentinel) Send Alarm if DAL is being attacked
2 participants