exp:explogs

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The log viewer on the command line: list the log files, follow one, search them and their rotations, find an error reference and the lines of its request (masked by default); rotate logs and prune their archives (dry run unless --apply)

Usage

./console exp:explogs [options]
php bin/php/explogs.php [options]
./console exp:logs [options]

Aliases

exp:logs

Help

The output of ./console help exp:explogs (the script run with --help), without the standard options:

Usage: bin/php/explogs.php [OPTION]...
The log viewer on the command line (read only; e-mail and IP addresses and secrets masked unless --unmask)

./console exp:logs --list                                  the log files: group, size, time, lines a minute
./console exp:logs --tail=var/log/error.log --lines=50     the last 50 entries
./console exp:logs --tail=var/log/error.log --follow       follow it (Ctrl-C ends)
./console exp:logs --search=timeout --file=var/log/error.log --rotations --level=error,warning
./console exp:logs --search='/content/view/\d+' --regex --scope=kernel --from='2026-10-17 01:00' --to='2026-10-17 02:00'
./console exp:logs --reference=ERR-0123456789          where an error page's reference is, and its request
./console exp:logs --related=var/log/error.log:123456      the lines of the request of the entry at that offset

Log management (doc/eng-us/features/6.0/log-rotation.md):
./console exp:logs --archives                              each log with its archives and their sizes
./console exp:logs --rotate=error,debug --apply            rotate these logs now (keys as in --archives, or ids)
./console exp:logs --rotate-all --apply                    rotate every log that is not empty
./console exp:logs --prune                                 the archives beyond site.ini [FileSettings] limits
./console exp:logs --prune=error --apply                   remove them (all logs, or these)
./console exp:logs --compress --apply                      compress the archives from .2 on
./console exp:logs --truncate=debug [--in-place] --apply   empty a log (rotated, or in place)
--rotate, --rotate-all, --prune, --compress and --truncate change files only with --apply; without it
they print the plan. --dry-run means the same as no --apply; --apply together with --dry-run is a usage
error (exit 2).

Exit code: 0 something listed or found, 1 nothing found, 2 error.


Options:
  --list             List the log files the viewer may open, by group, with size, time and lines a minute
  --archives         List the logs that can be rotated, with their archives (.1 .. .N, .gz) and sizes, and the limits
  --rotate=VALUE     Rotate these logs now, whatever their size: keys (error,debug,site-storage) or ids (var/log/error.log), comma separated
  --rotate-all       Rotate every log over its MaxSize (with --force: every log that is not empty)
  --force            With --rotate-all: also the logs under their MaxSize
  --prune=VALUE      Remove the archives beyond the limits (Keep, MaxAgeDays): of every log, or of these keys
  --days=VALUE       With --prune: remove archives older than this many days instead of MaxAgeDays
  --compress=VALUE   Compress the plain archives from .2 on: of every log, or of these keys
  --truncate=VALUE   Empty these logs: rotate them (the content stays in .1), or with --in-place empty the file itself
  --in-place         With --truncate: empty the file in place, keeping no copy
  --apply            With --rotate, --rotate-all, --prune, --compress or --truncate: change the files (the default is a dry run that prints the plan)
  --dry-run          The default, kept for scripts that pass it: only print the plan
  --tail=VALUE       The last entries of a file (its path relative to the root, e.g. var/log/error.log)
  --lines=VALUE      With --tail: how many entries (default 20)
  --follow           With --tail: go on printing what the file gains, polling with backoff (Ctrl-C ends)
  --interval=VALUE   With --follow: the shortest poll interval in milliseconds (default [TailSettings] PollInterval)
  --search=VALUE     Search for a text (literal, or a regular expression with --regex)
  --regex            With --search: the text is a regular expression (bounded by [SearchSettings] BacktrackLimit and TimeLimit)
  --case             With --search: case sensitive
  --file=VALUE       With --search: the file (default: [LogViewerSettings] DefaultFile)
  --scope=VALUE      With --search: file (default), kernel (every kernel log) or all (every file listed)
  --rotations        With --search: the rotations (.1 .. .N, .gz) too
  --level=VALUE      Only these levels: error,warning,notice,debug
  --from=VALUE       Only entries at or after this time (e.g. 2026-10-17 01:00)
  --to=VALUE         Only entries at or before this time (a date alone means the whole day)
  --sa=VALUE         Only entries of this siteaccess
  --uri=VALUE        Only entries whose request contains this text
  --ip=VALUE         Only entries whose client address starts with this
  --cursor=VALUE     With --search: go on from where an earlier search stopped (printed as "More: --cursor=...")
  --limit=VALUE      With --search: print at most this many entries
  --reference=VALUE  Find an error reference (ERR-XXXXXXXXXX) in the kernel logs and their rotations, with its request
  --related=VALUE    The lines of the same request as the entry at <file>:<offset>
  --unmask           Show e-mail addresses, IP addresses and secrets unmasked (the values of secret settings stay hidden)
  --json             One JSON object instead of the text
  --color=VALUE      Color the levels: auto (default: when the output is a terminal), always, never

Options

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/explogs.php, kernel/private/classes/commands/explogs.php

See also

Generated example: exp:explogs

Added to the reference for Exponential 6.0.15.