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

Enable Sentry asyncio integration #5685

Merged
merged 1 commit into from
Feb 28, 2025
Merged

Conversation

agners
Copy link
Member

@agners agners commented Feb 27, 2025

Proposed change

Enable the Sentry asyncio integration. This makes sure that exception in non-awaited tasks get reported to sentry.

While at it, use partial instead of lambda for the filter function.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:
  • Link to client library pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Summary by CodeRabbit

  • Chores
    • Improved the underlying error tracking for asynchronous operations to enhance overall system stability.

Enable the Sentry asyncio integration. This makes sure that exception
in non-awaited tasks get reported to sentry.

While at it, use partial instead of lambda for the filter function.
@agners agners added the new-feature A new feature label Feb 27, 2025
Copy link
Contributor

coderabbitai bot commented Feb 27, 2025

📝 Walkthrough

Walkthrough

The change updates the Sentry integration in the supervisor module by importing asynchronous support and cleaning up the event filtering. The new import of AsyncioIntegration from sentry_sdk.integrations.asyncio is added. Additionally, the before_send parameter is refactored from a lambda function to a partial function call that binds coresys to the filter_data function. The asynchronous integration is then included in the Sentry SDK initialization.

Changes

File Change Summary
supervisor/.../sentry.py - Added import: from sentry_sdk.integrations.asyncio import AsyncioIntegration
- Refactored before_send from a lambda to partial(filter_data, coresys)
- Included AsyncioIntegration() in the integrations list

Sequence Diagram(s)

sequenceDiagram
    participant Supervisor as Supervisor Module
    participant SentrySDK as Sentry SDK
    participant Filter as filter_data

    Supervisor->>SentrySDK: Initialize sentry_sdk.init (with AsyncioIntegration and before_send)
    SentrySDK->>Filter: Invoke before_send (partial(filter_data, coresys))
Loading

📜 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 c5d4ebc and 6b01b9a.

📒 Files selected for processing (1)
  • supervisor/utils/sentry.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Build i386 supervisor
  • GitHub Check: Build armv7 supervisor
  • GitHub Check: Build armhf supervisor
  • GitHub Check: Build aarch64 supervisor
  • GitHub Check: Run tests Python 3.13.2
🔇 Additional comments (4)
supervisor/utils/sentry.py (4)

3-3: Good addition of the partial function import.

Adding partial from functools allows for a cleaner approach to function composition than using lambda functions.


9-9: Great addition of AsyncioIntegration.

This import enables Sentry to capture exceptions occurring in non-awaited tasks, which is the main objective of this PR.


31-31: Excellent refactoring from lambda to partial function.

Replacing the lambda function with a partial function improves code readability and maintainability. The partial function pre-binds the coresys parameter, making the code more explicit about what it's doing.


36-36:

❓ Verification inconclusive

Good integration of AsyncioIntegration into Sentry SDK.

Adding AsyncioIntegration() to the integrations list ensures that exceptions in non-awaited tasks will be properly reported to Sentry, which was the main goal of this PR.

Since the PR objectives mention that the author hasn't confirmed local testing, I recommend verifying this change works as expected with a test that creates a non-awaited task that raises an exception.


🏁 Script executed:

#!/bin/bash
# Check if there are any tests that verify Sentry integration behavior
rg -t python "test.*sentry" --exclude-dir="*venv*"

Length of output: 468


Ensure local Sentry behavior with non-awaited exceptions is verified

The integration of AsyncioIntegration() in the Sentry configuration looks solid. However, since there isn’t an automated test confirming that exceptions from non-awaited tasks are reported to Sentry, please verify this locally. In particular, add or run a test that creates a non-awaited task which raises an exception to confirm that Sentry captures it as expected.

  • File: supervisor/utils/sentry.py, line 36 (AsyncioIntegration(),)
✨ Finishing Touches
  • 📝 Generate Docstrings

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>, please review it.
    • Generate unit testing code 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 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.
  • @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.

@agners agners merged commit 362bd8f into main Feb 28, 2025
21 checks passed
@agners agners deleted the enable-sentry-asyncio-integration branch February 28, 2025 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants