Skip to content

Purge Daemon Configuration

The Purge Daemon is responsible for automatically removing old data from the system, including job logs, event logs, expired sessions, old messages, old statistics, and expired SMS messages.

The purge configuration is split into two sections: the daemon schedule configuration (config.daemon.purge) and the purge rules configuration (config.purge).

Daemon Schedule Configuration

These options control when the purge daemon runs.

sleep_period

  • Default: 3600 (seconds)
  • Description: The number of seconds the daemon sleeps between purge checks.

iterations

  • Default: 1000
  • Description: The number of iterations before ending daemon execution.

next_purge_date

  • Description: The next date the purge will execute. This is set automatically after each purge run.

min_purge_time

  • Default: 02:00
  • Description: The earliest time of day (HH:MM) the purge is allowed to run.

max_purge_time

  • Default: 04:00
  • Description: The latest time of day (HH:MM) the purge is allowed to run.

stop_purge_if_overtime

  • Default: 1
  • Description: If set to 1, the purge will stop processing jobs and logs if the current time exceeds max_purge_time.

Purge Rules Configuration

These options control what gets purged and how long data is retained.

Job Purge

keep_job_files

  • Default: 30
  • Description: Number of days to keep job files on disk.

keep_jobs_ok

  • Default: 30
  • Description: Number of days to keep successfully completed (OK) job logs.

keep_jobs_ko

  • Default: 30
  • Description: Number of days to keep failed (KO) job logs.

no_job_purge

  • Default: 0
  • Description: Set to 1 to prevent Clarive from purging job logs entirely.

job_purge_batch_size

  • Default: 100
  • Description: Number of jobs to process in each batch during purge. Larger batches are faster but consume more memory.

Event Purge

Event purge settings specify the number of days to retain event log entries. Setting a value to 0 disables purging for that event type.

event_ok_purge

  • Default: 7
  • Description: Number of days to keep OK (successful) event log entries. Set to 0 to disable purging of OK events.

event_ko_purge

  • Default: 7
  • Description: Number of days to keep KO (failed) event log entries. Set to 0 to disable purging of KO events.

event_auth_purge

  • Default: 0 (disabled)
  • Description: Number of days to keep login/authentication event log entries. Set to 0 to disable purging of auth events. Authentication events are not purged by default.

event_purge_batch_size

  • Default: 5000
  • Description: Number of events to process in each batch during purge.

Log File Rotation

no_file_purge

  • Default: 0
  • Description: Set to 1 to prevent Clarive from rotating and purging log files.

keep_rotation_level

  • Default: 7
  • Description: Number of compressed rotated files to keep for each log file.

keep_nginx-error_log_size

  • Default: 4
  • Description: Maximum size in megabytes for the nginx error log before rotation.

keep_nginx-access_log_size

  • Default: 4
  • Description: Maximum size in megabytes for the nginx access log before rotation.

keep_mongod_log_size

  • Default: 4
  • Description: Maximum size in megabytes for the mongod log before rotation.

keep_disp_log_size

  • Default: 4
  • Description: Maximum size in megabytes for the dispatcher log before rotation.

keep_web_log_size

  • Default: 4
  • Description: Maximum size in megabytes for the web server log before rotation.

Other

keep_stats

  • Default: 30
  • Description: Number of days to keep process statistics.

keep_sent_messages

  • Default: 30D
  • Description: Duration to keep sent messages. Uses duration format: 30D (30 days), 1M (1 month), etc.