Profiler: Memory

Use this action to start the memory profiler for the specified number of seconds. It helps you analyze how Home Assistant uses memory.

This action requires an administrator account.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To start the memory profiler from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Search for and select Profiler: Memory.
6. Optionally, set the number of Seconds to run the profile.
7. Select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as profiler.memory. A basic example looks like this:

action: profiler.memory
data:
  seconds: 120

This runs the memory profiler for 120 seconds.

Options in YAML

This action does not support targets.

Good to know

When the memory profile is complete, the profiler generates a .hpy file in your configuration directory. The exact path appears in a notification, so you can find and copy it.

You can open the hpy file with any text editor. For a visual representation, use the Heapy Profile Browser, which is part of the guppy3 package and can be launched with the following script:

#!/usr/bin/python3
from guppy import hpy
hpy().pb()

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Profiler: Start: Starts the profiler for a set number of seconds.

• Profiler: Start log objects: Starts logging the growth of objects in memory.

• Profiler: LRU stats: Logs statistics from LRU caches.