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_monthsdays 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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
sysLogArchiveId | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const logArchive = new SimpleLogArchive(); logArchive.removeUnpacked('161478566913431857'); |
runPacking()
This method packs outdated logs into an archive. By By default, logs older than one month are considered outdated. You can edit this value by changing the the simple.logs.rotate_period_in_months system days system property value.
Return:
Type | String |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
sysLogArchiveId | String | Y | N |
Return:
Type | String |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const logArchive = new SimpleLogArchive(); logArchive.runUnpacking('161478566913431857'); |
Table of Contents | ||||
---|---|---|---|---|
|