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

Make log rollover at startup #54865

Merged
merged 3 commits into from
Aug 20, 2021
Merged

Conversation

janiversen
Copy link
Member

Breaking change

Proposed change

This PR solves 2 problems:
a) when using "--log-rotate-days" delay=True was missing, leading to a slower (in load conditions) handling
b) whenever hass is started home-assistant.log is cleared and all information gone, this is especially true when running hass as a daemon with an automatic restart.

Changed logging.FileHandler to logging.handlers.RotatingFileHandler, and then call .rotate in order to create 1 file: home-assistant.log.bak in order to preserve the old log.

Having either logging.handlers.RotatingFileHandler or logging.handlers.TimedRotatingFileHandler (already in place), allows a future PR to extend the developer tools with a new command ("change log") to secure the log.

Type of change

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

Additional information

I could not find a place in homeassistant.io that talks about how logging works (e.g. use of --log-rotate-days).

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation 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 Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@janiversen janiversen requested a review from a team as a code owner August 19, 2021 06:49
@probot-home-assistant probot-home-assistant bot added bugfix core small-pr PRs with less than 30 lines. labels Aug 19, 2021
homeassistant/bootstrap.py Outdated Show resolved Hide resolved
homeassistant/bootstrap.py Outdated Show resolved Hide resolved
@janiversen janiversen merged commit 1e34524 into home-assistant:dev Aug 20, 2021
@janiversen janiversen deleted the make_log_bak branch August 20, 2021 16:16
@github-actions github-actions bot locked and limited conversation to collaborators Aug 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bugfix cla-signed core small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants