Versions Compared

Key

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

This server-side class allows operations with log archives.

removeUnpacked(sysLogArchiveId)


This method allows removing unpacked outdated logs. By default, logs older than one month are considered outdated. You can edit this value by changing the simple.logs.rotate_period_in_days system property value.

Note that the log archive is not deleted when calling this method. It deletes only temporary tables containing logs that were created within previous unpacking.


Parameter(s):

NameTypeMandatoryDefault Value
sysLogArchiveIdStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleremoveUnpacked
linenumberstrue
<![CDATA[const logArchive = new SimpleLogArchive();
logArchive.removeUnpacked('161478566913431857');


runPacking()


This method packs outdated logs into an archive. By default, logs older than one month are considered outdated. You can edit this value by changing the simple.logs.rotate_period_in_days system property value.


Return:

TypeString
VoidThis method does not return a value.


Example:

Code Block
languagejs
titlerunPacking
<![CDATA[const logArchive = new SimpleLogArchive();
logArchive.runPacking();

runUnpacking(sysLogArchiveId)


This method runs log archive unpacking. After unpacking is over, logs can be found in log tables listed in the related article: Logging


Parameter(s):

NameTypeMandatoryDefault Value
sysLogArchiveIdStringYN


Return:

TypeString
VoidThis method does not return a value.


Example:

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


Table of Contents
classfixedPosition
printablefalse