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

feat: add debugging for retries #283

Merged
merged 2 commits into from
Dec 17, 2023
Merged

feat: add debugging for retries #283

merged 2 commits into from
Dec 17, 2023

Conversation

jxnl
Copy link
Owner

@jxnl jxnl commented Dec 16, 2023

Summary by CodeRabbit

  • Refactor
    • Enhanced logging within the retry mechanisms to improve monitoring and debugging capabilities.

Copy link
Contributor

coderabbitai bot commented Dec 16, 2023

Walkthrough

The update includes enhancements to logging within two functions: retry_async and retry_sync. New log statements are introduced to capture exceptions and debug information, aiding in better monitoring and troubleshooting without altering any public API or functionality.

Changes

File Change Summary
instructor/patch.py Added exception logging in retry_async and debug logging in both retry_async and retry_sync functions.

🐇✍️

In functions of sync and async flair,
Logs spring up here and there,
A rabbit codes with utmost care,
Debugging trails left with a hare's rare flair. 🌟🥕

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 X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

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

@jxnl jxnl marked this pull request as ready for review December 16, 2023 18:31
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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f0d76ac and 7addb98.
Files selected for processing (1)
  • instructor/patch.py (2 hunks)

Comment on lines +240 to +241
logger.exception(f"Retrying, exception: {e}")
logger.debug(f"Error response: {response}")
Copy link
Contributor

Choose a reason for hiding this comment

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

The added logging statements in the retry_async function are consistent with the PR's objective of enhancing debugging for retry operations. However, the debug log at line 241 may potentially log sensitive information since it logs the entire error response. Consider sanitizing or selectively logging information to avoid potential PII leakage or security issues.

@@ -282,6 +284,7 @@
)
except (ValidationError, JSONDecodeError) as e:
logger.exception(f"Retrying, exception: {e}")
logger.debug(f"Error response: {response}")
Copy link
Contributor

Choose a reason for hiding this comment

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

Similar to the retry_async function, ensure that the debug log at line 287 does not log sensitive information. It's important to sanitize or selectively log information to prevent potential PII leakage or security issues.

@jxnl jxnl merged commit 78a8905 into main Dec 17, 2023
15 checks passed
@jxnl jxnl deleted the debug-error-response branch December 17, 2023 02:49
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.

None yet

1 participant