Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This class contains methods for managing log archives.

removeUnpacked(sysLogArchiveId)


Use this method to remove unpacked outdated logsthe 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.Note that this method does not delete the log archive. It deletes only the temporary tables containing the logs that were created within the previous unpacking.

Parameter(s):

NameTypeMandatoryDefault value
sysLogArchiveIdStringYN

Return:

TypeDescription
VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titleremoveUnpacked()
linenumberstrue
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:

Code Block
languagejs
titlerunPacking()
linenumberstrue
const logArchive = new SimpleLogArchive();
logArchive.runPacking();

runUnpacking(sysLogArchiveId)


Use this method tounpack 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:

Code Block
languagejs
themeEclipse
titlerunUnpacking()
linenumberstrue
const logArchive = new SimpleLogArchive();
logArchive.runUnpacking('161478566913431857');


Table of Contents
classfixedPosition
printablefalse