Purge recorder data by default (#12271)
This commit is contained in:
1 parent
219ed7331c
commit
247edf1b69
5 files changed
+63
-48
No files matched your search
@@ -43,10 +43,12 @@ DOMAIN = 'recorder'
|
||||
SERVICE_PURGE = 'purge'
|
||||
|
||||
ATTR_KEEP_DAYS = 'keep_days'
|
||||
ATTR_REPACK = 'repack'
|
||||
|
||||
SERVICE_PURGE_SCHEMA = vol.Schema({
|
||||
vol.Required(ATTR_KEEP_DAYS):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=0))
|
||||
vol.Optional(ATTR_KEEP_DAYS):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=0)),
|
||||
vol.Optional(ATTR_REPACK, default=False): cv.boolean
|
||||
})
|
||||
|
||||
DEFAULT_URL = 'sqlite:///{hass_config_path}'
|
||||
@@ -76,7 +78,7 @@ FILTER_SCHEMA = vol.Schema({
|
||||
|
||||
CONFIG_SCHEMA = vol.Schema({
|
||||
DOMAIN: FILTER_SCHEMA.extend({
|
||||
vol.Optional(CONF_PURGE_KEEP_DAYS):
|
||||
vol.Optional(CONF_PURGE_KEEP_DAYS, default=10):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=1)),
|
||||
vol.Optional(CONF_PURGE_INTERVAL, default=1):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=0)),
|
||||
@@ -122,12 +124,6 @@ def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
|
||||
keep_days = conf.get(CONF_PURGE_KEEP_DAYS)
|
||||
purge_interval = conf.get(CONF_PURGE_INTERVAL)
|
||||
|
||||
if keep_days is None and purge_interval != 0:
|
||||
_LOGGER.warning(
|
||||
"From version 0.64.0 the 'recorder' component will by default "
|
||||
"purge data older than 10 days. To keep data longer you must "
|
||||
"configure 'purge_keep_days' or 'purge_interval'.")
|
||||
|
||||
db_url = conf.get(CONF_DB_URL, None)
|
||||
if not db_url:
|
||||
db_url = DEFAULT_URL.format(
|
||||
@@ -144,7 +140,7 @@ def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
|
||||
@asyncio.coroutine
|
||||
def async_handle_purge_service(service):
|
||||
"""Handle calls to the purge service."""
|
||||
instance.do_adhoc_purge(service.data[ATTR_KEEP_DAYS])
|
||||
instance.do_adhoc_purge(**service.data)
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN, SERVICE_PURGE, async_handle_purge_service,
|
||||
@@ -153,7 +149,7 @@ def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
|
||||
return (yield from instance.async_db_ready)
|
||||
|
||||
|
||||
PurgeTask = namedtuple('PurgeTask', ['keep_days'])
|
||||
PurgeTask = namedtuple('PurgeTask', ['keep_days', 'repack'])
|
||||
|
||||
|
||||
class Recorder(threading.Thread):
|
||||
@@ -188,10 +184,12 @@ class Recorder(threading.Thread):
|
||||
"""Initialize the recorder."""
|
||||
self.hass.bus.async_listen(MATCH_ALL, self.event_listener)
|
||||
|
||||
def do_adhoc_purge(self, keep_days):
|
||||
def do_adhoc_purge(self, **kwargs):
|
||||
"""Trigger an adhoc purge retaining keep_days worth of data."""
|
||||
if keep_days is not None:
|
||||
self.queue.put(PurgeTask(keep_days))
|
||||
keep_days = kwargs.get(ATTR_KEEP_DAYS, self.keep_days)
|
||||
repack = kwargs.get(ATTR_REPACK)
|
||||
|
||||
self.queue.put(PurgeTask(keep_days, repack))
|
||||
|
||||
def run(self):
|
||||
"""Start processing events to save."""
|
||||
@@ -261,7 +259,8 @@ class Recorder(threading.Thread):
|
||||
@callback
|
||||
def async_purge(now):
|
||||
"""Trigger the purge and schedule the next run."""
|
||||
self.queue.put(PurgeTask(self.keep_days))
|
||||
self.queue.put(
|
||||
PurgeTask(self.keep_days, repack=not self.did_vacuum))
|
||||
self.hass.helpers.event.async_track_point_in_time(
|
||||
async_purge, now + timedelta(days=self.purge_interval))
|
||||
|
||||
@@ -294,7 +293,7 @@ class Recorder(threading.Thread):
|
||||
self.queue.task_done()
|
||||
return
|
||||
elif isinstance(event, PurgeTask):
|
||||
purge.purge_old_data(self, event.keep_days)
|
||||
purge.purge_old_data(self, event.keep_days, event.repack)
|
||||
self.queue.task_done()
|
||||
continue
|
||||
elif event.event_type == EVENT_TIME_CHANGED:
|
||||
|
||||
@@ -9,13 +9,14 @@ from .util import session_scope
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def purge_old_data(instance, purge_days):
|
||||
def purge_old_data(instance, purge_days, repack):
|
||||
"""Purge events and states older than purge_days ago."""
|
||||
from .models import States, Events
|
||||
from sqlalchemy import orm
|
||||
from sqlalchemy.sql import exists
|
||||
|
||||
purge_before = dt_util.utcnow() - timedelta(days=purge_days)
|
||||
_LOGGER.debug("Purging events before %s", purge_before)
|
||||
|
||||
with session_scope(session=instance.get_session()) as session:
|
||||
# For each entity, the most recent state is protected from deletion
|
||||
@@ -55,10 +56,10 @@ def purge_old_data(instance, purge_days):
|
||||
|
||||
# Execute sqlite vacuum command to free up space on disk
|
||||
_LOGGER.debug("DB engine driver: %s", instance.engine.driver)
|
||||
if instance.engine.driver == 'pysqlite' and not instance.did_vacuum:
|
||||
if repack and instance.engine.driver == 'pysqlite':
|
||||
from sqlalchemy import exc
|
||||
|
||||
_LOGGER.info("Vacuuming SQLite to free space")
|
||||
_LOGGER.debug("Vacuuming SQLite to free space")
|
||||
try:
|
||||
instance.engine.execute("VACUUM")
|
||||
instance.did_vacuum = True
|
||||
|
||||
@@ -6,3 +6,6 @@ purge:
|
||||
keep_days:
|
||||
description: Number of history days to keep in database after purge. Value >= 0.
|
||||
example: 2
|
||||
repack:
|
||||
description: Attempt to save disk space by rewriting the entire database file.
|
||||
example: true
|
||||
Reference in new issue
Block a user