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, the 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 the logs that were created within previous unpacking.

Parameter(s):

.

Параметры:

НазваниеТипОбязательныйЗначение по умолчаниюNameTypeMandatoryDefault Value
sysLogArchiveIdStringYДаNНет

ReturnВозвращаемое значение:

TypeТипDescriptionОписание
VoidThis method does not return a valueМетод не возвращает значение.

ExampleПример:

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

runPacking()


This method packs outdated logs into an archive. By default, the 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Возвращаемое значение:

TypeТипStringОписание
VoidThis method does not return a valueМетод не возвращает значение.

ExampleПример:

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

runUnpacking(sysLogArchiveId)

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

Parameter(s):


Используйте этот метод, чтобы запустить распаковку архива журнала. После завершения распаковки журналы помещаются в соответствующие таблицы журналов. Подробнее читайте в статье Системные журналы.

Параметры:

НазваниеТипОбязательныйЗначение по умолчаниюNameTypeMandatoryDefault Value
sysLogArchiveIdStringYДаNНет

ReturnВозвращаемое значение:

TypeТипStringОписание
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