Skip to content

Add regex-based filters to logger component#48439

Merged
bdraco merged 2 commits intohome-assistant:devfrom
jshufro:jms/logger-regex
Mar 30, 2021
Merged

Add regex-based filters to logger component#48439
bdraco merged 2 commits intohome-assistant:devfrom
jshufro:jms/logger-regex

Conversation

@jshufro
Copy link
Copy Markdown
Contributor

@jshufro jshufro commented Mar 28, 2021

Proposed change

Adds a section to component logger configuration for regex filters to suppress log messages based on patterns.

I've been using home-assistant for a variety of "mission critical" automations (i.e.: if these automations don't run, my pipes might freeze!). I'd like to set up a trigger based on the logging service that texts me on any log message, but it is unfortunately quite noisy. A degree of log suppression is provided by setting service log levels, but I would like finer-grained control.

Docs PR: home-assistant/home-assistant.io#17160

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

Example entry for configuration.yaml:

logger:
  default: info
  logs:
    some.service: debug
  filters:
    some.service:
     - "HTTP 429"
     - "^Temporary error:"
    some.other_service:
     - "Request to .*unreliable.com Timed Out"

Additional information

Implemented with care not to introduce any breaking changes :)

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.
  • 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:

@homeassistant
Copy link
Copy Markdown
Contributor

Hi @jshufro,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/core, mind taking a look at this pull request as its been labeled with an integration (logger) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

Comment thread homeassistant/components/logger/__init__.py Outdated
@jshufro jshufro requested a review from bdraco March 28, 2021 18:23
Comment thread homeassistant/components/logger/__init__.py
Comment thread homeassistant/components/logger/__init__.py Outdated
Copy link
Copy Markdown
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

Please see comment above

@jshufro jshufro requested a review from bdraco March 28, 2021 19:35
Copy link
Copy Markdown
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread tests/components/logger/test_init.py Outdated
@bdraco bdraco merged commit f5d9713 into home-assistant:dev Mar 30, 2021
@jshufro jshufro deleted the jms/logger-regex branch March 30, 2021 17:07
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 31, 2021
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.

3 participants