Skip to content

Improve template ratelimit performance#41741

Merged
balloob merged 3 commits intohome-assistant:devfrom
bdraco:improve_ratelimit_performance
Oct 15, 2020
Merged

Improve template ratelimit performance#41741
balloob merged 3 commits intohome-assistant:devfrom
bdraco:improve_ratelimit_performance

Conversation

@bdraco
Copy link
Copy Markdown
Member

@bdraco bdraco commented Oct 12, 2020

Proposed change

The rate limit has been optimized to:

  • Only examine the template that hit the rate limit when the rate limit expires (previously it checked all the templates being tracked -- only affected template entities since they can have multiple)
  • Do not re-render if the template entities being watched have change and not longer match since the rate limit was hit
  • If the template contains no domains and only all states and specific entities we do not check for domains in the filter
  • Improves the performance of checking if there is a rate limit on large template blocks (they are more expensive to hash)

Testing step:
5x of the below template sensor and turning on the scale test integration: https://github.com/bdraco/scaletest

sensor:
  - platform: template
    sensors:
      unavailable_entities:
        entity_id: sensor.time
        friendly_name: Unavailable Entities
        unit_of_measurement: items
        icon_template: >
          {% if states('sensor.unavailable_entities')|int == 0 %}
            mdi:check-circle
          {% else %}
            mdi:alert-circle
          {% endif %}
        value_template: >
          {% if states('sensor.uptime_in_uren')|float > 0.05|float %}
            {{states|selectattr('state', 'in', ['unavailable','unknown','none'])
              |reject('in', expand('group.entity_blacklist'))
              |reject('eq', states.group.entity_blacklist)
              |list|length}}
           {% else %}
            0
          {% endif %}
        attribute_templates:
          entities: >
            {{states|selectattr('state', 'in', ['unavailable','unknown','none'])
              |reject('in', expand('group.entity_blacklist'))
              |reject('eq' , states.group.entity_blacklist)
              |map(attribute='entity_id')|list|join(', ')}}

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:

# Example configuration.yaml

Additional information

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

@balloob
Copy link
Copy Markdown
Member

balloob commented Oct 15, 2020

About the large template hashing, doesn't Python generate the hash once and then cache it?

@balloob balloob merged commit 21cc232 into home-assistant:dev Oct 15, 2020
weissm pushed a commit to weissm/core that referenced this pull request Oct 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants