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

Remove unhealthy after failed update on startup #5412

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Nov 12, 2024

Proposed change

One of the outcomes of the recent update issues is our handling of an update failure at startup does not make sense. Currently we react very aggressively to an update failure at this time with logging and marking the system as unhealthy. This seems like it comes from a time when users blocked Supervisor updates via firewall before we had the option to disable auto-update. As this was the one bit of code that ran before they could tweak Supervisor's container with addon hacks, we used that to inform them of the problematic situation they were in.

Now they can simply disable auto-update if they want. So an update failure at startup is really no different from a startup failure at any point in time. And since all other updates are blocked while Supervisor is out of date I wouldn't really consider Supervisor unhealthy. There's an issue which we create any time a Supervisor update fails but its not unhealthy:

except DockerError as err:
self.sys_resolution.create_issue(
IssueType.UPDATE_FAILED, ContextType.SUPERVISOR
)
capture_exception(err)
raise SupervisorUpdateError(
f"Update of Supervisor failed: {err!s}", _LOGGER.error
) from err

I also removed the aggressive logging and exception capture at this point in the code because its redundant. As you can see we already capture the real exception and there's already logging about this. I bumped the level to critical to match the existing level.

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

  • New Features

    • Enhanced error handling and logging for Supervisor updates, now treating failures with higher urgency.
    • Improved connectivity checks by recreating web sessions on connection failures.
  • Bug Fixes

    • More robust error handling for file operations in the update_apparmor method.
  • Refactor

    • Streamlined error handling in the Supervisor update process for clarity and efficiency.

@mdegat01 mdegat01 added the bugfix A bug fix label Nov 12, 2024
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

📝 Walkthrough

Walkthrough

The changes made in this pull request involve modifications to the error handling and logging mechanisms within the Core and Supervisor classes. In supervisor/core.py, the error handling during the Supervisor update process has been simplified by replacing a try-except block with a conditional check using a context manager. In supervisor/supervisor.py, the logging level for update failures has been elevated to critical, and the error handling in the update_apparmor method has been improved. Additionally, connectivity checks have been refined to enhance reliability.

Changes

File Change Summary
supervisor/core.py Simplified error handling in start method; replaced try-except with context manager for SupervisorUpdateError. Removed logging of critical errors related to updates. Minor formatting adjustments.
supervisor/supervisor.py Changed logging level for update failures from _LOGGER.error to _LOGGER.critical. Enhanced error handling in update_apparmor for OSError. Refined connectivity check logic to recreate web session on failure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Supervisor
    participant Core

    User->>Core: start()
    Core->>Supervisor: update()
    Supervisor->>Supervisor: Check for errors
    alt Error occurs
        Supervisor->>Supervisor: Log critical error
        Supervisor->>Supervisor: Handle OSError
    else No error
        Supervisor-->>Core: Update successful
    end
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9f414ee and 7e60c18.

📒 Files selected for processing (2)
  • supervisor/core.py (1 hunks)
  • supervisor/supervisor.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
supervisor/core.py (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

supervisor/supervisor.py (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (2)
supervisor/supervisor.py (1)

208-208: LGTM! The logging level change aligns with the PR objectives.

The change from error to critical logging level is appropriate for update failures and maintains consistency with how update failures are handled at other times. The error handling correctly creates an issue without marking the system as unhealthy.

Let's verify the consistency of error handling across the codebase:

supervisor/core.py (1)

211-214: LGTM! The changes improve error handling for Supervisor updates.

The new implementation correctly:

  1. Prevents update attempts when system is unhealthy
  2. Uses suppress context manager to handle update failures gracefully
  3. Removes redundant error handling that marked system as unhealthy

This aligns with the PR objectives by treating update failures during startup the same as failures at any other time.

Let's verify there are no other places in the codebase where update failures might still mark the system as unhealthy:


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 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 a8e7bb6 into main Nov 14, 2024
21 checks passed
@agners agners deleted the remove-unhealthy-update-failure branch November 14, 2024 08:41
@github-actions github-actions bot locked and limited conversation to collaborators Nov 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants