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

Adjust remote ESPHome log subscription level on logging change #139308

Merged
merged 7 commits into from
Feb 26, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Feb 26, 2025

Proposed change

If the logging level changes, notify the ESP device to adjust the level of logging subscription to avoid sending logs that will be filtered by the current log level.

If we only want info/warning/error logs this can significantly reduce the traffic coming from the ESP since previously we had no way to adjust the log level once it was set once. Now we can match the logger levels and only get log traffic for what we need. All devices already support this, however there was a small change to aioesphomeapi to allow the callback subscription to be cancelled needed via #139309 to be able to change remote log level more than once per connection.

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)
  • Deprecation (breaking change to happen in the future)
  • 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 developer documentation pull request:
  • Link to frontend 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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format 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.

To help with the load of incoming pull requests:

If the logging level changes, notify the ESP device to adjust
the level of logging subscription to avoid sending logs that
will be filtered by the current log level.
@home-assistant
Copy link

Hey there @OttoWinter, @jesserockz, @kbx81, mind taking a look at this pull request as it has been labeled with an integration (esphome) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of esphome can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign esphome Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@bdraco bdraco marked this pull request as ready for review February 26, 2025 00:56
@bdraco bdraco added this to the 2025.3.0b0 milestone Feb 26, 2025
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @bdraco 👍

../Frenck

@frenck frenck merged commit eb26a21 into dev Feb 26, 2025
32 checks passed
@frenck frenck deleted the esphome_log_opt branch February 26, 2025 07:58
@bdraco
Copy link
Member Author

bdraco commented Feb 26, 2025

Thanks

@github-actions github-actions bot locked and limited conversation to collaborators Feb 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants