1. Home
  2. Docs
  3. Recording
  4. Recording profile
  5. Archiving


The Jeyzer Recording archiving drives the JZR recording generation and reduces the disk space footprint of the recording snapshots.

Periodically, the Jeyzer Recorder archives the oldest recording snapshots into a JZR recording file.
After being archived, the recording snapshots are being deleted from the disk.

The JZR recording is either a zip file on Windows or a tar.gz file on Unix.
JZR recordings get stored into an archive directory.
By default, the archive directory is located under the recording one.

Archiving period is configurable and set by default to 5 minutes.
For a production environment, it is recommended to set it to a period between 4 and 12 hours.

Archive on shutdown
Archiving can also occur on a proper shutdown which corresponds to a kill -10 or Ctrl-C signal.
Archiving on shutdown is disabled by default.
It can be activated through the archive_on_shutdown parameter.
This is very convenient. It is for example enabled on the Jeyzer demos.
In some cases, you may prefer keep the archiving periodic splitting for consistency.

Archiving offset
A minimum offset duration is always applied between the last recording snapshot and the archiving.
It is set through the archiving_time_offset duration field.
Offset must at least be a multiple of the recording snapshot period.
If the Jeyzer Monitor is in place, it must be higher than its scanning period.

Zip file will be named as follow :
<archive_prefix>-<time zone origin>-<start date>---<start time>---<end date>---<end time>.zip

The archive_prefix is usually set to :

Archive rolling

Rolling archive mechanism applies on the JZR recordings : the Jeyzer Recorder deletes automatically the oldest JZR recording when the number of those exceeds a certain configurable threshold (file_limit).
By default, the last 10 JZR recordings are kept.
For a production environment, Jeyzer Recorder should be configured to keep the last few days of activity.

<archiving period="${JEYZER_RECORD_ARCHIVE_PERIOD}" archive_on_shutdown="false">

  <storage archive_dir="${JEYZER_RECORD_ARCHIVE_DIR}" archive_prefix="jzr-rec-"/>

  <retention file_limit="${JEYZER_RECORD_ARCHIVE_FILE_LIMIT}"/>

  <archiving_time_offset duration="${JEYZER_RECORD_ARCHIVE_TIME_OFFSET}"/>