logviewer.ini [LogViewerSettings] #

The block [LogViewerSettings] of settings/logviewer.ini, with 12 setting(s).

Never edit settings/logviewer.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/logviewer.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/logviewer.ini.append.php for one siteaccess,
• extension/<extension>/settings/logviewer.ini.append.php in an extension (read when the extension is active).

LogViewer #

enabled | disabled. With disabled, setup/logs and its feed answer 404.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
LogViewer=enabled
*/ ?>

Directories #

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).

Default: a list of 3: var/log, {log_dir}, var/*/log.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "Directories[]" first replaces the shipped list; without it the items are added
Directories[]
Directories[]=var/log
Directories[]={log_dir}
Directories[]=var/*/log
*/ ?>

FilePatterns #

The file names shown (shell patterns): the log files, their rotations (.1 .. .N) and compressed rotations
(.gz, read only: viewed and searched, never followed).

Default: a list of 6: *.log, *.log.[0-9], *.log.[0-9][0-9], *.log.[0-9].gz, *.log.[0-9][0-9].gz, *.log.gz.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "FilePatterns[]" first replaces the shipped list; without it the items are added
FilePatterns[]
FilePatterns[]=*.log
FilePatterns[]=*.log.[0-9]
FilePatterns[]=*.log.[0-9][0-9]
FilePatterns[]=*.log.[0-9].gz
FilePatterns[]=*.log.[0-9][0-9].gz
FilePatterns[]=*.log.gz
*/ ?>

ExcludePatterns #

File names never shown (shell patterns), whatever the lists above say.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "ExcludePatterns[]" first replaces the shipped list; without it the items are added
ExcludePatterns[]
*/ ?>

KernelLogs #

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.
The request logs (doc/eng-us/features/6.0/request-logs.md): the not found requests (404, 410) and the requests the
request classifier took for an attack (any status), one line per request.

Default: a list of 15: error.log, warning.log, notice.log, debug.log, strict.log, deprecated.log, auth.log, cronjob*.log, storage.log, setup.log, mail.log, trashpurge.log ....

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "KernelLogs[]" first replaces the shipped list; without it the items are added
KernelLogs[]
KernelLogs[]=error.log
KernelLogs[]=warning.log
KernelLogs[]=notice.log
KernelLogs[]=debug.log
KernelLogs[]=strict.log
KernelLogs[]=deprecated.log
KernelLogs[]=auth.log
KernelLogs[]=cronjob*.log
KernelLogs[]=storage.log
KernelLogs[]=setup.log
KernelLogs[]=mail.log
KernelLogs[]=trashpurge.log
KernelLogs[]=404.log
KernelLogs[]=security.log
KernelLogs[]=csp.log
*/ ?>

DefaultKey #

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.

Default: error.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
DefaultKey=error
*/ ?>

DefaultFile #

Default: var/log/error.log.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
DefaultFile=var/log/error.log
*/ ?>

LogList #

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.

Default: a list of 2: webserver-access, webserver-error.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "LogList[]" first replaces the shipped list; without it the items are added
LogList[]
LogList[]=webserver-access
LogList[]=webserver-error
*/ ?>

LogPath #

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "LogPath[]" first replaces the shipped list; without it the items are added
LogPath[]
*/ ?>

LogLabel #

Default: a hash of 6: 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.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "LogLabel[]" first replaces the shipped list; without it the items are added
LogLabel[]
LogLabel[webserver-access]=Web server access log
LogLabel[webserver-error]=Web server error log
LogLabel[404]=Not found requests (404)
LogLabel[security]=Security (request classifier)
LogLabel[csp]=Content Security Policy reports
LogLabel[velocity-watchdog]=Velocity watchdog
*/ ?>

LogGroup #

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "LogGroup[]" first replaces the shipped list; without it the items are added
LogGroup[]
*/ ?>

FileLevels #

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.
The request logs name no level: a not found request is a notice (it is an answer, not a fault), a request the
classifier took for an attack a warning (worth a look, listed by the error digest by default).

Default: a list of 10: 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.

<?php /* #?ini charset="utf-8"?
# settings/override/logviewer.ini.append.php
[LogViewerSettings]
# an empty "FileLevels[]" first replaces the shipped list; without it the items are added
FileLevels[]
FileLevels[]=error.log*;error
FileLevels[]=*error*.log*;error
FileLevels[]=warning.log*;warning
FileLevels[]=strict.log*;warning
FileLevels[]=deprecated.log*;notice
FileLevels[]=notice.log*;notice
FileLevels[]=debug.log*;debug
FileLevels[]=404.log*;notice
FileLevels[]=security.log*;warning
FileLevels[]=csp.log*;warning
*/ ?>

Related #

• All blocks of logviewer.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/logviewer.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.