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(low-code): improve logging on async retriever errors #307

Merged
merged 2 commits into from
Feb 2, 2025

Conversation

maxi297
Copy link
Contributor

@maxi297 maxi297 commented Jan 31, 2025

See this Slack thread for more information

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced error logging for async job processing by adding traceback information to warnings, improving visibility into potential issues during job orchestration.

@maxi297
Copy link
Contributor Author

maxi297 commented Jan 31, 2025

/autofix

Auto-Fix Job Info

This job attempts to auto-fix any linting or formating issues. If any fixes are made,
those changes will be automatically committed and pushed back to the PR.

Note: This job can only be run by maintainers. On PRs from forks, this command requires
that the PR author has enabled the Allow edits from maintainers option.

PR auto-fix job started... Check job output.

🟦 Job completed successfully (no changes).

@github-actions github-actions bot added the enhancement New feature or request label Jan 31, 2025
Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a modification in the create_and_get_completed_partitions method of the AsyncJobOrchestrator class within the Airbyte CDK's declarative async job orchestration module. A new logging statement has been added to capture and log a warning when an exception occurs during the job processing loop, enhancing error visibility. The previous logging statement that logged the exception without the traceback has been removed, while the overall structure of the exception handling remains unchanged.

Changes

File Change Summary
airbyte_cdk/sources/declarative/async_job/job_orchestrator.py Updated exception logging in create_and_get_completed_partitions method to log warnings with traceback during job processing exceptions

The modification maintains the existing exception handling logic while improving error visibility through more comprehensive logging. The change does not alter the fundamental control flow or job orchestration process.

Would you like to explore more about how this logging enhancement could impact debugging processes? Wdyt?


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26629fe and c3fac9c.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/async_job/job_orchestrator.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • airbyte_cdk/sources/declarative/async_job/job_orchestrator.py
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Check: 'source-pokeapi' (skip=false)
  • GitHub Check: Check: 'source-the-guardian-api' (skip=false)
  • GitHub Check: Check: 'source-shopify' (skip=false)
  • GitHub Check: Check: 'source-hardcoded-records' (skip=false)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Analyze (python)

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 (1)
airbyte_cdk/sources/declarative/async_job/job_orchestrator.py (1)

440-442: The logging addition looks good! Would you consider enhancing it further?

The new warning log for caught exceptions improves visibility into async retriever errors, which aligns well with the PR's objective. However, we could make it even more helpful for debugging purposes.

What do you think about including the traceback information? Here's a suggestion, wdyt?

-                LOGGER.warning(
-                    f"Caught exception that stops the processing of the jobs: {exception}"
-                )
+                LOGGER.warning(
+                    f"Caught exception that stops the processing of the jobs: {exception}. Traceback: {traceback.format_exc()}"
+                )
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 10a7a87 and 26629fe.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/async_job/job_orchestrator.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Check: 'source-pokeapi' (skip=false)
  • GitHub Check: Check: 'source-the-guardian-api' (skip=false)
  • GitHub Check: Check: 'source-shopify' (skip=false)
  • GitHub Check: Check: 'source-hardcoded-records' (skip=false)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
  • GitHub Check: Analyze (python)

@maxi297
Copy link
Contributor Author

maxi297 commented Jan 31, 2025

@coderabbitai I'm good with your suggestion here. Can you make the change?

Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

@maxi297 I'll help you implement the suggested change to include traceback information in the warning log. Here's the code:

LOGGER.warning(
    f"Caught exception that stops the processing of the jobs: {exception}. Traceback: {traceback.format_exc()}"
)

This change will provide better visibility into async retriever errors by including the full stack trace in the log message. Would you like me to make this change?

🔗 Analysis chain
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Fetch the review comment using GitHub CLI
gh api -X GET "/repos/airbytehq/airbyte-python-cdk/pulls/307/reviews/2587988079" | jq -r '.body'

Length of output: 2146


Script:

#!/bin/bash
# Fetch the current content of the file
cat airbyte_cdk/sources/declarative/async_job/job_orchestrator.py

Length of output: 21056

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@maxi297
Copy link
Contributor Author

maxi297 commented Jan 31, 2025

@coderabbitai yes, please commit the change

Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

Tip

For best results, initiate chat on the files or code changes.

@maxi297 I apologize, but I am not able to directly commit changes to the repository. However, I can provide you with the code that you can use to make the change:

LOGGER.warning(
    f"Caught exception that stops the processing of the jobs: {exception}. Traceback: {traceback.format_exc()}"
)

You can copy this code and implement it in the _abort_all_running_jobs method. Would you like me to help you with anything else?

Copy link
Contributor

@bazarnov bazarnov left a comment

Choose a reason for hiding this comment

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

I believe the error type we try to catch is too general, we have to have a way to define this error type into a specific one at least or catch both specific and general like overall

@maxi297
Copy link
Contributor Author

maxi297 commented Feb 1, 2025

Is the concern that we log too much? The user was having an issue and was not seeing the issue with the current logging solution.

@bazarnov
Copy link
Contributor

bazarnov commented Feb 1, 2025

No, i believe we could have a specific case to catch first than catch the general Exception so we start having the errors base we might face in the future, instead of just Expection. This is basically a part of the re-factoring so no blocking you and will do this in my PR

@maxi297 maxi297 merged commit ef97304 into main Feb 2, 2025
24 checks passed
@maxi297 maxi297 deleted the maxi297/improve-async-retriever-error-logging branch February 2, 2025 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants