This document describes the current stable version of Celery (5.6). For development docs, go here.

# `celery.events.snapshot`

Periodically store events in a database.

Consuming the events as a stream isn’t always suitable so this module implements a system to take snapshots of the state of a cluster at regular intervals. There’s a full implementation of this writing the snapshots to a database in `djcelery.snapshots` in the django-celery distribution.

class celery.events.snapshot.Polaroid(state, freq=1.0, maxrate=None, cleanup_freq=3600.0, timer=None, app=None)

  Record event snapshots.

  cancel()
  capture()
  cleanup()
  cleanup_signal = <Signal: cleanup_signal providing_args=set()>
  clear_after = False
  install()
  on_cleanup()
  on_shutter(state)
  shutter()
  shutter_signal = <Signal: shutter_signal providing_args={'state'}>
  timer = None

celery.events.snapshot.evcam(camera, freq=1.0, maxrate=None, loglevel=0, logfile=None, pidfile=None, timer=None, app=None, **kwargs)

  Start snapshot recorder.