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

chore: Reduce RTS error log spam #31917

Merged
merged 1 commit into from Mar 19, 2024
Merged

chore: Reduce RTS error log spam #31917

merged 1 commit into from Mar 19, 2024

Conversation

sharat87
Copy link
Member

@sharat87 sharat87 commented Mar 19, 2024

We're logging the entire request/response, Axios config etc. in the logs, which isn't adding any value in troubleshooting, but is making reading logs much harder.

This PR will print only the essential information to logs, concisely.

Summary by CodeRabbit

  • Refactor
    • Improved error handling in socket authentication for more structured error logging.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Mar 19, 2024
@sharat87 sharat87 marked this pull request as ready for review March 19, 2024 12:15
Copy link
Contributor

coderabbitai bot commented Mar 19, 2024

Walkthrough

Walkthrough

The update enhances error handling within a specific function by refining how errors are logged. It incorporates structured logging of error responses and ensures that general error causes are captured as strings. This adjustment aims to improve debugging efficiency by offering clearer insights into error origins and details.

Changes

File Path Change Summary
.../rts/src/middlewares/socket-auth.ts Updated error handling in tryAuth to use JSON.stringify for logging error.response.data and error.cause details as strings.

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Comment on lines 46 to 55
} else if (error.response) {
log.error(
"Error response received while authentication: ",
error.response,
JSON.stringify(error.response.data), // this is so the message shows up in one line.
);
} else {
log.error("Error authenticating", error);
log.error("Error authenticating", error.cause?.toString());
}
return false;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Regarding the TODO comment about deriving API_BASE_URL from the host header instead of using an environment variable: This is an important consideration for simplifying configuration. However, the note about Axios not working for HTTPS endpoints needs attention. It's crucial to address this limitation to ensure secure communication, especially for authentication purposes.

Would you like assistance in debugging the Axios issue with HTTPS endpoints or exploring alternative HTTP clients that support HTTPS?

@sharat87 sharat87 merged commit 34c59c8 into release Mar 19, 2024
24 of 25 checks passed
@sharat87 sharat87 deleted the chore/rts-log-spam branch March 19, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants