Skip to main content

Retention

Argus stores every detection as an event, and a clip for every rule match. Without cleanup, the database and clip storage grow with every camera and every busy hour. The site-retention service deletes old data on a schedule, using the policy you set in Settings, General.

The policy​

SettingDefaultWhat it does
Standard Retention (Days)30Events older than this are deleted, unless an open alert refers to them.
Hard Backstop (Days)OffEvents older than this are deleted even if an open alert refers to them. Leave it blank to turn it off.
Sweep Interval (Hours)6How long the service waits between sweeps.

You can use fractions, for example 0.5 days.

What a sweep deletes​

For each event past the window:

  • The event's clip in object storage.
  • Workflow runs that the event started.
  • Alerts on the event, and their action history.
  • The event itself.

After that, the sweep deletes tracks that are past the window and have no events left.

Open alerts protect evidence​

An event is kept while it has an open alert, however old it is. This stops Argus from deleting the clip behind an alert nobody has looked at. Once the alert is acknowledged, resolved or dismissed, the event and its clip are deleted at the next sweep past the window.

The hard backstop​

If alerts on your site are not always triaged, open alerts could keep clips forever. Set a hard backstop to put an upper limit on that. Events older than the backstop are deleted even if their alert is still open.

The backstop must be longer than the retention window.

Change the policy​

You need the admin role.

  1. Open Settings and pick General.
  2. Under Retention Policy, set the standard retention, the hard backstop and the sweep interval.
  3. Click Save Configuration.

The service reads the policy at the start of every sweep, so you don't need to restart anything. A new policy applies from the next sweep. A new sweep interval starts counting after the current wait ends.

Argus checks your values when you save:

  • The retention window must be more than 0.
  • The sweep interval must be more than 0.
  • The hard backstop, if set, must be longer than the retention window.

Check that sweeps run​

After each sweep, the site-retention service writes a line to its log like this:

[retention] sweep complete — deleted <events> events, <clips> clip objects, <tracks> tracks, <runs> workflow runs, ...

Check the log after the first sweep with a new policy. If it shows an ERROR line instead, the service tries again at the next sweep; contact us if the error repeats. See Operations for how to read service logs.

Changes to the policy are recorded in the audit log.

note

The sweep doesn't delete the audit log, user accounts or your configuration, such as cameras, zones, profiles and workflows.

Size your storage​

How much space you need depends on the number of cameras, how busy they are, how many rules match and your retention window. Argus does not set a size limit on the database or clip storage. Watch the free space on your site node. For help sizing a site, contact us.

Was this page helpful?