Skip to main content
Version: 1.23.3

SimpleLogArchive

This class provides methods for managing log archives. Only the following tables are archivable:

  • Main Log (sys_log)
  • Script Log (sys_log_script)
  • Exception Log (sys_log_exception)

removeUnpacked(sysLogArchiveId)


Use this method to remove the temporary tables that contain the logs from the previous unpacking. By default, the logs older than one month are considered outdated. You can edit the archiving period with the simple.logs.rotate_period_in_days system property.

Parameter(s):

NameTypeMandatoryDefault value
sysLogArchiveIdStringYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

removeUnpacked()
const logArchive = new SimpleLogArchive();
logArchive.removeUnpacked('161478566913431857');

runPacking()


Use this method to pack outdated logs into an archive. By default, the logs older than one month are considered outdated. You can edit the archiving period with the simple.logs.rotate_period_in_days system property.

Return:

TypeDescription
VoidThis method does not return a value.

Example:

runPacking()
const logArchive = new SimpleLogArchive();
logArchive.runPacking();

runUnpacking(sysLogArchiveId)


Use this method to unpack a log archive. When the unpacking is finished, the logs are placed in the related log tables. See the System Audit articles to learn more.

Parameter(s):

NameTypeMandatoryDefault value
sysLogArchiveIdStringYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

runUnpacking()
const logArchive = new SimpleLogArchive();
logArchive.runUnpacking('161478566913431857');