jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-06-25 19:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document new profiler object logging with source (#26842)

Browse Source
This commit is contained in:
J. Nick Koston 2023-04-02 20:59:48 -10:00 committed by GitHub
parent f92d56b13e
commit acf7767dc2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
source/_integrations/profiler.markdown
View File

@ -81,12 +81,29 @@ Start logging the growth of objects in memory.
| ---------------------- | -------- | ----------- |
| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks.
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks. This service can be run for long periods to find slow leaks. For finding fast leaks, `profiler.start_log_object_sources` is preferred; however, it is much more CPU intensive.
### Service `profiler.stop_log_objects`
Stop logging the growth of objects in memory.
### Service `profiler.start_log_object_sources`
Start logging the growth of objects in memory and attempt to find the source of the new objects.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0
| `max_objects` | yes | The number of new objects to examine for source information. Defaults to 5
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks.
This service is similar to `start_log_objects` except that it is much more CPU intensive since it will attempt to locate the source of each new object up to `max_objects` each time it logs.
### Service `profiler.stop_log_object_sources`
Stop logging the growth of objects with sources in memory.
### Service `profiler.dump_log_objects`
| Service data attribute | Optional | Description |