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

Reduce log spamming #2354

Merged
merged 1 commit into from
Jan 31, 2025
Merged

Reduce log spamming #2354

merged 1 commit into from
Jan 31, 2025

Conversation

nick-bisonai
Copy link
Collaborator

Description

Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

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 20, 2025
@nick-bisonai nick-bisonai requested a review from a team as a code owner January 20, 2025 02:33
Copy link
Contributor

coderabbitai bot commented Jan 20, 2025

📝 Walkthrough

Walkthrough

The pull request modifies logging behavior in the WebSocket fetcher for the XT provider. In two files (utils.go and xt.go), the log level for specific error scenarios has been changed from Error to Warn. The changes enhance logging by reducing the severity of messages related to feed data conversion and providing more contextual information about missing or unprocessed data.

Changes

File Change Summary
node/pkg/websocketfetcher/providers/xt/utils.go Modified log level from Error to Warn when a feed is not found; updated log message to include original symbol
node/pkg/websocketfetcher/providers/xt/xt.go Changed log level from Error to Warn when response conversion to feed data fails

Possibly related PRs

Suggested reviewers

  • Intizar-T

Poem

🐰 A Rabbit's Log Tale 🔍

From Error's loud and thunderous roar,
To Warn's soft whisper at the core,
Logs dance with grace, context so clear,
No more alarm, just wisdom's cheer!

Hop hop, log smart! 🚀

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/websocketfetcher/providers/xt/xt.go (1)

73-73: LGTM! Consider adding feed details to the log message.

The change from Error to Warn is appropriate since this is a per-message conversion issue that doesn't affect the overall service. To aid in debugging, consider including the raw message details in the log.

-    log.Warn().Str("Player", "Xt").Err(err).Msg("error in xt.handleMessage, failed to convert response to feed data")
+    log.Warn().Str("Player", "Xt").Err(err).Interface("raw", raw).Msg("error in xt.handleMessage, failed to convert response to feed data")
node/pkg/websocketfetcher/providers/xt/utils.go (1)

16-16: LGTM! The added context improves debuggability.

The change from Error to Warn is appropriate for missing feeds, and including the raw symbol in the log message helps with debugging. Consider standardizing the player string case for consistency.

-    log.Warn().Str("Player", "xt").Str("raw", response.Data.Symbol).Str("key", symbol).Msg("feed not found")
+    log.Warn().Str("Player", "Xt").Str("raw", response.Data.Symbol).Str("key", symbol).Msg("feed not found")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 67a38a9 and 8fd0f4d.

📒 Files selected for processing (2)
  • node/pkg/websocketfetcher/providers/xt/utils.go (1 hunks)
  • node/pkg/websocketfetcher/providers/xt/xt.go (1 hunks)

@nick-bisonai nick-bisonai merged commit 45f06d2 into master Jan 31, 2025
1 check failed
@nick-bisonai nick-bisonai deleted the fix/reduce-log-spamming branch January 31, 2025 02:20
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