Support

Documentation

Log management

These commands allow you to manage the log files which are generated when taking backups.

akeeba:log:list

What it does: Lists log files known to Akeeba Backup.

This command lists all log files which are found in the backup output directory of a selected backup profile. In short, it lists files on your server's disk. This has a few corollaries you should be aware of.

You may see some log files which do not directly correspond to a backup record such as the generic log file kept for each backup origin (backend, frontend, CLI and JSON API).

You may also see log files from backup records which have been deleted outside Akeeba Backup, e.g. after restoring an older backup.

If you have changed the output directory of a backup profile the log files in the old output directory will NOT be listed.

If you have deleted a log file outside of Akeeba Backup it will not be listed.

LIkewise, this command may not list all log files for all of your backup profiles if one or more backup profiles use a different output directory.

It is possible that one or more backup profiles share the same backup output directory. It's also possible that more than one Akeeba Backup installations (sites) share the same backup output directory – even though that's not recommended and can lead to difficult to troubleshoot issues. In case of a shared output directory you will see a list of all log files regardless of which Akeeba Backup installation or profile they came from.

Syntax: akeeba:log:list [PROFILE_ID] [--format=FORMAT]

Arguments

This command takes one optional argument.

PROFILE_ID

Optional. The numeric profile ID. The profile's output directory will be used to list backup log files. If omitted the default backup profile ID (1) will be used.

Options

--format=FORMAT

Optional. Change the output format as explained earlier.

Exit codes

One of the following exit codes will be set when the command finishes running:

0

The command completed without an error.