Feat: Improve log file handling for connector failures

[Aaron ("AJ") Steers (aaronsteers)]

This does a few small but nice things:

1. Fix the issue where the connector log file was printed three times if an execption was raised.
2. Move the log file handling into the Exception class "str" implementation - making it easier to read and easier to find.
3. Move the AIRBYTE_LOGGING_ROOT env var processing into the public constants module so that it is self-documenting in our API docs.

Summary by CodeRabbit

• New Features

  • Enhanced logging functionality with a standardized logging root path and improved log file naming conventions for better readability and traceability.
  • Introduced a new function and global variable to optimize logging directory retrieval, allowing users to customize their logging setup.

• Documentation

  • Updated documentation strings for new functions and variables to provide clear guidance on logging configuration.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the logging functionality in the Airbyte application. Key modifications include standardizing the logging root path, introducing a caching function for efficient retrieval of the logging directory, and improving log file naming conventions for better context. These updates aim to streamline logging processes and enhance clarity in log file management.

Changes

Files	Change Summary
airbyte/_connector_base.py, airbyte/constants.py	Modified logging functionality to standardize the logging root path and enhance log file naming conventions. A new caching function for efficient retrieval of the logging directory was introduced in constants.py, improving configurability. The _new_log_file method was removed to consolidate logging logic.

Wydt about this summary? Would you like to include any additional details or modifications?

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 19e7482 and 0f035a3.

Files selected for processing (1)

• airbyte/_connector_base.py (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• airbyte/_connector_base.py

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 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.

[Aaron ("AJ") Steers (aaronsteers)]

CodeRabbit (@coderabbitai) review

[Aaron ("AJ") Steers (aaronsteers)]

CodeRabbit (@coderabbitai) review

[coderabbitai]

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (2)

airbyte/constants.py (1)

66-73: Clarify the documentation for AIRBYTE_LOGGING_ROOT.

The documentation for AIRBYTE_LOGGING_ROOT is clear, but consider explicitly stating the default path in the docstring for quick reference.

"""
The root directory for Airbyte logs.

This value can be overridden by setting the `AIRBYTE_LOGGING_ROOT` environment variable.
If not provided, PyAirbyte will use `/tmp/airbyte/logs/` where `/tmp/` is the OS's default
temporary directory.
"""

airbyte/exceptions.py (1)

Line range hint 273-287:
Review _get_log_file method for robustness.

The _get_log_file method retrieves the log file path from logger handlers. Ensure that this method correctly handles cases where no file handler is present or the logger is misconfigured.

def _get_log_file(self) -> Path | None:
    """Return the log file path for the connector."""
    if self.connector_name:
        logger = logging.getLogger(f"airbyte.{self.connector_name}")

        log_paths = [
            Path(handler.baseFilename).absolute()
            for handler in logger.handlers
            if isinstance(handler, logging.FileHandler) and hasattr(handler, 'baseFilename')
        ]

        if log_paths:
            return log_paths[0]

    return None

[coderabbitai]

Actionable comments posted: 1

[Aaron ("AJ") Steers (aaronsteers)]

/fix-pr

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.
(This job requires that the PR author has "Allow edits from maintainers" enabled.)

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

✅ Changes applied successfully.