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

Draft: Add more logging options (DO NOT MERGE) #444

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Nov 7, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a new logging configuration option to control whether logs for each connector are written to separate files or (also) consolidated into the main log file.
    • Expanded documentation to include instructions for adding custom log handlers to the global logger.

Copy link

vercel bot commented Nov 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
pyairbyte-api-docs ❌ Failed (Inspect) Nov 7, 2024 7:00pm

Copy link

coderabbitai bot commented Nov 7, 2024

Warning

Rate limit exceeded

@aaronsteers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 37 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 251acf2 and 71eec55.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request enhance the logging functionality of the PyAirbyte library by introducing a new boolean variable, ISOLATED_CONNECTOR_LOGS, which determines whether logs for each connector are written to separate files or consolidated into the main log file. The behavior of this variable is influenced by the AIRBYTE_ISOLATED_CONNECTOR_LOGS environment variable. Modifications are made to the new_passthrough_file_logger function to accommodate this feature, and the documentation is updated to include instructions for adding custom log handlers.

Changes

File Change Summary
airbyte/logs.py Added ISOLATED_CONNECTOR_LOGS variable; modified new_passthrough_file_logger to use this variable; expanded documentation for custom log handlers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Logger
    participant GlobalLogger

    User->>Logger: Configure logs
    Logger->>Logger: Check ISOLATED_CONNECTOR_LOGS
    alt Isolated logs
        Logger->>Logger: Disable propagation
        Logger->>Logger: Write to connector-specific log
    else Consolidated logs
        Logger->>GlobalLogger: Enable propagation
        Logger->>GlobalLogger: Write to main log
    end
Loading

What do you think about this sequence diagram? Does it capture the flow accurately?


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 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 or @coderabbitai title 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

@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

🧹 Outside diff range and nitpick comments (2)
airbyte/logs.py (2)

11-26: Documentation looks great, but there's a small typo! 🎯

The documentation for custom log handlers is clear and helpful. However, there's an incomplete sentence on line 79: "including ." - seems like something got cut off there. What did you mean to include in that sentence?

Also applies to: 79-79


66-80: Extra quote in docstring - small fix needed! 🔍

The implementation looks solid, but there's an extra quote in the docstring (line 72). Would you mind fixing that?

-""""Whether to write logs for each connector to a separate file.
+"""Whether to write logs for each connector to a separate file.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7c703ac and 251acf2.

📒 Files selected for processing (1)
  • airbyte/logs.py (3 hunks)
🔇 Additional comments (1)
airbyte/logs.py (1)

316-321: Implementation looks good! One thing to verify... 🤔

The logic for controlling log propagation is clear and well-commented. Just want to make sure we've considered all scenarios - what happens if someone changes ISOLATED_CONNECTOR_LOGS at runtime? Should we perhaps add a note in the docs about when this setting takes effect?

Let's check if there are any existing loggers that might be affected by runtime changes:

✅ Verification successful

Runtime changes to ISOLATED_CONNECTOR_LOGS are safe! 🎯

The implementation is actually quite robust! Each connector gets a fresh logger instance through new_passthrough_file_logger() and the propagation setting is applied at creation time. No loggers are cached globally - they're created per-connector instance and stored as instance attributes (self._file_logger). This means runtime changes to ISOLATED_CONNECTOR_LOGS will affect new loggers but won't disrupt existing ones, which is exactly what we want!

Maybe we could add a small doc note about this behavior for clarity, wdyt? 🤔

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for instances where this logger is cached or stored
rg -l "new_passthrough_file_logger"

Length of output: 78


Script:

#!/bin/bash
# Let's check how the logger is used in _connector_base.py
rg -A 5 "new_passthrough_file_logger" airbyte/_connector_base.py

# Also check if there are any caching or storage of logger instances
ast-grep --pattern 'logger = $$$'

Length of output: 816

airbyte/logs.py Outdated Show resolved Hide resolved
airbyte/logs.py Outdated Show resolved Hide resolved
airbyte/logs.py Outdated Show resolved Hide resolved
airbyte/logs.py Outdated Show resolved Hide resolved
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