[LogViewerSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [LogViewerSettings] of settings/logviewer.ini.
File
settings/logviewer.ini; override it in settings/override/logviewer.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| LogViewer | enabled | enabled | disabled. With disabled, setup/logs and its feed answer 404. |
| Directories[] | var/log; {log_dir}; var/*/log | The directories whose log files are shown, relative to the installation root (or absolute, still inside it). A * matches one directory name (var/*/log is the log directory of every site). Only the files directly in a directory are listed, never its subdirectories (the audit trail in var/log/audit has its own console), and a directory or file that resolves (realpath) outside the installation root is never shown, so a symbolic link cannot lead anywhere else. {log_dir} is the log directory eZDebug writes to (var/log, or var/<site>/log with site.ini [FileSettings] UseGlobalLogDir=disabled). |
| FilePatterns[] | *.log; *.log.[0-9]; *.log.[0-9][0-9]; *.log.[0-9].gz; *.log.[0-9][0-9].gz; *.log.gz | The file names shown (shell patterns): the log files, their rotations (.1 .. .N) and compressed rotations (.gz, read only: viewed and searched, never followed). |
| ExcludePatterns[] | (empty array) | File names never shown (shell patterns), whatever the lists above say. |
| KernelLogs[] | error.log; warning.log; notice.log; debug.log; strict.log; deprecated.log; auth.log; cronjob*.log; storage.log; setup.log; mail.log; trashpurge.log; 404.log; security.log; csp.log | The groups of the navigator. A file whose name matches KernelLogs[] is in "Kernel", a file in another site's log directory (var/<site>/log) in "Site", any other in "Extensions"; a rotation (.1 .. .N, .gz) is in "Rotated archives". Shell patterns of the current file's name. |
| DefaultKey | error | The log opened when the page is opened without one: a key (see below), else the file DefaultFile (relative to the root). When neither can be opened: the first kernel log. |
| DefaultFile | var/log/error.log | |
| LogList[] | webserver-access; webserver-error | Every log has a key, used in its permalink /setup/logs/view/<key> (doc/eng-us/features/6.0/log-viewer.md, "Permalinks"): var/log/<name>.log <name> e.g. /setup/logs/view/error, /setup/logs/view/debug var/<site>/log/<name>.log <site>-<name> e.g. /setup/logs/view/site-storage and the logs configured here by key, such as the web server's. A key names only these: never a path. LogList[] lists the configured keys, LogPath[<key>] the file (absolute, or relative to the root; it may be outside the installation, as the web server's logs are; its rotations <name>.N and <name>.N.gz beside it are listed too), LogLabel[<key>] the name the navigator shows, LogGroup[<key>] its group (kernel, site, extensions, webserver; the default webserver). A key without a LogPath is not shown: the web server's logs are opt-in, never guessed. The web server's user must be able to read the file (Plesk: /var/www/vhosts/<domain>/logs/access_ssl_log and error_log). The actions rotate, empty and remove are never offered for the webserver group: the web server owns those files. LogLabel[<key>] also names a log of the log directories by its key (var/log/404.log is the key 404); the label is translated (context kernel/logviewer) when the translation has it. |
| LogPath[] | (empty array) | |
| LogLabel[<key>] | webserver-access=Web server access log; webserver-error=Web server error log; 404=Not found requests (404); security=Security (request classifier); csp=Content Security Policy reports; velocity-watchdog=Velocity watchdog | |
| LogGroup[] | (empty array) | |
| FileLevels[] | error.log*;error; *error*.log*;error; warning.log*;warning; strict.log*;warning; deprecated.log*;notice; notice.log*;notice; debug.log*;debug; 404.log*;notice; security.log*;warning; csp.log*;warning | The level of a file whose lines do not name one: <file name pattern>;<level> (error, warning, notice, debug). The first pattern that matches wins; a line that names its level ("Error:", "[warning]") always wins. |
See also
Generated example: logviewer.ini [LogViewerSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/logviewer.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment